sahih_validator 0.0.6

Flutter validation library

SahihValidator 🔐

A comprehensive and powerful Flutter validation library that provides robust validation

Table of Contents 📋

• SahihValidator 🔐
  • Table of Contents 📋
  • Features ✨
  • Detailed Usage Guide 📖
    • 1. Email Validation 📧
    • 2. Phone Number Validation 📱
    • 3. Password Validation 🔒
      • Simple Login Password Validation
      • Password Strength Validation
    • 4. Address Validation 🏠
    • 5. URL Validation 🌐
    • 6. Custom Validation ⚙️
    • 7. Date of Birth Validation 🎂
  • Form Integration 📝
    • Basic Form Integration
  • Best Practices 💡
  • Contributing 🤝
  • License 📄
  • Support 💬

Features ✨

• 📧 Email Validation: RFC-compliant email format validation with duplicate checking
• 📱 Phone Validation: International phone number format validation (10-15 digits)
• 🔒 Password Validation: Both simple login validation and comprehensive strength checking
• 🏠 Address Validation: Detailed address validation with component requirements
• 🌐 URL Validation: Asynchronous URL validation with domain verification options
• ⚙️ Custom Validation: Flexible validation with multiple configurable rules
• 📝 Form Integration: Perfect integration with Flutter's form validation system
• 🌍 Internationalization: Customizable error messages for all validation types
• 🎯 Type Safety: Full Dart type safety with comprehensive error handling

Detailed Usage Guide 📖

1. Email Validation 📧

Email validation supports RFC-compliant format checking and duplicate detection:

String? emailError = SahihValidator.email(
  email: "[e-mail]",
  emptyMessage: "Email is required",
  invalidFormatMessage: "Please enter a valid email address",
  trimWhitespace: true, // Remove leading/trailing spaces (default: true)
  existingEmails: ["[e-mail]", "[e-mail]"], // Check for duplicates
  alreadyExistsMessage: "This email is already registered",
);

Valid email formats:

• [e-mail]
• [e-mail]
• [e-mail]
• [e-mail]

Invalid email formats:

• plainaddress (missing @ and domain)
• @domain.com (missing username)
• user@ (missing domain)
• user@domain (missing TLD)

2. Phone Number Validation 📱

Phone validation accepts international formats with 10-15 digits:

String? phoneError = SahihValidator.phone(
  phone: "[phone]",
  emptyMessage: "Phone number is required",
  invalidFormatMessage: "Please enter a valid phone number (10-15 digits)",
  trimWhitespace: true,
  existingPhones: ["1234567890", "0987654321"], // Check for duplicates
  alreadyExistsMessage: "This phone number is already registered",
);

Valid phone formats:

• 1234567890 (10 digits)
• [phone] (with country code)
• 123456789012345 (up to 15 digits)

Invalid phone formats:

• 123 (too short)
• 123-456-7890 (contains dashes)
• [phone] (contains spaces and parentheses)
• abcdefghij (contains letters)

3. Password Validation 🔒

Simple Login Password Validation

For login forms where you only need to check if password is not empty:

String? loginError = SahihValidator.loginPassword(
  password: "userpassword",
  emptyMessage: "Password is required to login",
);

Password Strength Validation

For registration forms with comprehensive strength checking:

String? strengthError = SahihValidator.passwordParts(
  "MySecureP@ssw0rd!",
  commonPasswords: ["companyname", "oldpassword"], // Optional custom weak passwords
);

Password strength requirements:

• Minimum 8 characters
• At least one uppercase letter (A-Z)
• At least one lowercase letter (a-z)
• At least one digit (0-9)
• Cannot be only numbers
• Cannot be a common/weak password
• Must have sufficient entropy (complexity)

4. Address Validation 🏠

Comprehensive address validation with component requirements:

String? addressError = SahihValidator.address(
  address: "123 Main Street, Springfield, USA",
  requireStreetNumber: true,
  requireStreetName: true,
  requireCity: true,
  requireCountry: true,
  minLength: 15,
  maxLength: 200,
  forbiddenWords: ["PO Box"], // Don't allow P.O. boxes
  missingStreetNumberMessage: "Address must include a street number",
  missingCountryMessage: "Address must include a country",
);

5. URL Validation 🌐

Asynchronous URL validation with multiple return types:

// Get validation message
String message = await SahihValidator.urlAsync<String>("https://example.com");

// Get boolean result
bool isValid = await SahihValidator.urlAsync<bool>("https://example.com");

// Get complete result with parsed data
UrlValidationResult result = await SahihValidator.urlAsync("https://example.com/path?q=1");
if (result.isValid) {
  print("Domain: ${result.data?.domain}");
  print("Protocol: ${result.data?.protocol}");
  print("Path: ${result.data?.path}");
}

// Advanced options
bool isValidRestricted = await SahihValidator.urlAsync<bool>(
  "https://example.com",
  allowedDomains: ["example.com", "trusted-site.org"],
  allowedSchemes: ["https"], // Only HTTPS allowed
  checkDomainExists: false, // Skip DNS lookup for performance
);

6. Custom Validation ⚙️

Flexible validation with multiple configurable rules:

// Username validation example
String? usernameError = SahihValidator.custom(
  value: "john_doe123",
  title: "Username",
  minLength: 3,
  maxLength: 20,
  pattern: r'^[a-zA-Z0-9_]+$', // Alphanumeric and underscore only
  existingValues: ["admin", "root", "john_doe123"],
  customValidator: (value) {
    if (value.startsWith('_')) return "Username cannot start with underscore";
    return null;
  },
);

// Product code validation example
String? productCodeError = SahihValidator.custom(
  value: "PRD-1234",
  title: "Product Code",
  pattern: r'^PRD-\d{4}$',
  invalidPatternMessage: "Product code must be in format PRD-XXXX (e.g., PRD-1234)",
);

7. Date of Birth Validation 🎂

The DateOfBirthValidator checks if the provided date is a valid date and if the user is of a certain age:

String? dobError = SahihValidator.dateOfBirth(
  date: DateTime(2000, 1, 1), // Example date
  minAge: 18, // Minimum age requirement
  invalidDateMessage: "Please enter a valid date",
  underAgeMessage: "You must be at least 18 years old",
);

Form Integration 📝

SahihValidator is designed to work seamlessly with Flutter's form validation system:

Basic Form Integration

TextFormField(
  validator: (value) => SahihValidator.email(
    email: value ?? '',
    emptyMessage: "Email is required",
  ),
  decoration: InputDecoration(labelText: "Email"),
)

Best Practices 💡

1. Use appropriate validation for context:

   • Use loginPassword for login forms
   • Use passwordParts for registration forms

2. Provide helpful error messages:

   • Customize error messages to guide users on how to fix validation errors
   • Be specific about requirements (e.g., "Password must be at least 8 characters")

3. Handle existing values:

   • Always check against existing values to prevent duplicates in your system
   • Use meaningful duplicate error messages

4. Use trimWhitespace:

   • Keep the default trimWhitespace: true unless you specifically need to preserve whitespace
   • This helps handle accidental user input with spaces

5. Combine validations:

   • Use multiple validation methods for complex forms to ensure data quality
   • Consider using custom validation for business-specific rules

6. Performance considerations:

   • For URL validation, avoid checkDomainExists: true unless necessary (requires network call)
   • Cache existing values lists when possible to avoid repeated database queries

Contributing 🤝

Contributions are welcome! Please feel free to submit a Pull Request.

License 📄

MIT License

Support 💬

For questions or support, please open an issue on GitHub.