catalogmx 0.5.1

Enterprise-grade Mexican data validation and official catalog library for Flutter/Dart - RFC, CURP, CLABE, NSS validators and 58+ government catalogs with 470K+ records

catalogmx (Dart/Flutter)

Enterprise-grade Mexican data validation and official catalog library for Flutter and Dart applications.

This is the official Dart/Flutter port of catalogmx, maintaining 100% API compatibility with the Python and TypeScript versions.

---

🚀 Features

Validators (100% Algorithm Compliant)

• ✅ RFC - Registro Federal de Contribuyentes (Tax ID)
• ✅ CURP - Clave Única de Registro de Población (National ID)
• ✅ CLABE - Clave Bancaria Estandarizada (Bank Account)
• ✅ NSS - Número de Seguridad Social (Social Security)

Official Catalogs

• 📦 INEGI - States, municipalities, localities
• 📦 SAT - Tax catalogs, airports, customs
• 📦 Banxico - Banks and financial institutions
• 📦 SEPOMEX - Postal codes (coming soon)

Enterprise Features

• 🎯 Type-safe - Full null-safety support for Dart 3.0+
• 📱 Cross-platform - Works on iOS, Android, Web, Desktop
• 🔒 Offline-first - All validators work without internet
• 🚀 Lightweight - Minimal dependencies
• 📚 Well-tested - Comprehensive unit tests
• 📖 Documented - Full API documentation

---

📦 Installation

Add this to your pubspec.yaml:

dependencies:
  catalogmx: ^0.5.0

Then run:

flutter pub get

---

🎯 Quick Start

Validators

import 'package:catalogmx/catalogmx.dart';

void main() {
  // Validate identifiers
  bool isValid = validateRFC('XAXX010101000');  // true
  bool isValidCurp = validateCURP('OEAF771012HMCRGR09');  // true
  bool isValidClabe = validateCLABE('002010077777777771');  // true
  bool isValidNss = validateNSS('12345678903');  // true

  // Generate RFC
  String rfc = generateRFC(
    nombre: 'Juan',
    apellidoPaterno: 'García',
    apellidoMaterno: 'López',
    fechaNacimiento: DateTime(1990, 5, 15),
  );

  // Generate CURP
  String curp = generateCURP(
    nombre: 'Juan',
    apellidoPaterno: 'García',
    apellidoMaterno: 'López',
    fechaNacimiento: DateTime(1990, 5, 15),
    sexo: 'H',
    estado: 'Jalisco',
  );

  // Generate CLABE
  String clabe = generateCLABE(
    bankCode: '002',
    branchCode: '010',
    accountNumber: '07777777777',
  );

  // Generate NSS
  String nss = generateNSS(
    subdelegation: '12',
    year: '34',
    serial: '56',
    sequential: '7890',
  );
}

Catalogs

import 'package:catalogmx/catalogmx.dart';

void main() {
  // Get all Mexican states
  List<Map<String, dynamic>> states = InegStates.getAll();

  // Get state by code
  Map<String, dynamic>? cdmx = InegStates.getByCode('DF');
  print(cdmx!['name']);  // "CIUDAD DE MEXICO"

  // Get state by name
  Map<String, dynamic>? jalisco = InegStates.getByName('Jalisco');

  // Search states
  List<Map<String, dynamic>> results = InegStates.search('mexico');
}

---

📚 Full Documentation

RFC (Registro Federal de Contribuyentes)

RFC is Mexico's tax identification number. There are two types:

• Persona Física (Individual): 13 characters
• Persona Moral (Company): 12 characters

// Validate RFC
bool isValid = validateRFC('OEAF771012HM8');

// Generate RFC for individual
String rfc = generateRFC(
  nombre: 'Juan',
  apellidoPaterno: 'García',
  apellidoMaterno: 'López',
  fechaNacimiento: DateTime(1990, 5, 15),
);

// Generate RFC for company
String rfcMoral = generateRFCMoral(
  razonSocial: 'Grupo Bimbo S.A.B. de C.V.',
  fechaConstitucion: DateTime(1993, 5, 5),
);

// Detect RFC type
RFCValidator validator = RFCValidator('OEAF771012HM8');
String type = validator.detectType();  // "Persona Física"
bool isFisica = validator.isFisica();  // true
bool isMoral = validator.isMoral();    // false

CURP (Clave Única de Registro de Población)

CURP is Mexico's unique population registry code (18 characters).

// Validate CURP
bool isValid = validateCURP('OEAF771012HMCRGR09');

// Generate CURP
String curp = generateCURP(
  nombre: 'Juan',
  apellidoPaterno: 'García',
  apellidoMaterno: 'López',
  fechaNacimiento: DateTime(1990, 5, 15),
  sexo: 'H',  // H=Male, M=Female
  estado: 'Jalisco',
);

// Extract information
CURPValidator validator = CURPValidator('OEAF771012HMCRGR09');
DateTime? birthDate = validator.getBirthDate();
String? gender = validator.getGender();  // "Hombre" or "Mujer"
String? stateCode = validator.getStateCode();

CLABE (Clave Bancaria Estandarizada)

CLABE is the standardized 18-digit bank account number for SPEI transfers.

// Validate CLABE
bool isValid = validateCLABE('002010077777777771');

// Generate CLABE
String clabe = generateCLABE(
  bankCode: '002',
  branchCode: '010',
  accountNumber: '07777777777',
);

// Extract information
Map<String, String?>? info = getCLABEInfo('002010077777777771');
print(info!['bank_code']);      // "002"
print(info['branch_code']);     // "010"
print(info['account_number']);  // "07777777777"

NSS (Número de Seguridad Social)

NSS is the 11-digit social security number issued by IMSS.

// Validate NSS
bool isValid = validateNSS('12345678903');

// Generate NSS
String nss = generateNSS(
  subdelegation: '12',
  year: '34',
  serial: '56',
  sequential: '7890',
);

// Extract information
Map<String, String?>? info = getNSSInfo('12345678903');
print(info!['subdelegation']);  // "12"
print(info['year']);           // "34"

---

🏗️ Platform Support

Platform	Status
Android	✅ Supported
iOS	✅ Supported
Web	✅ Supported
Windows	✅ Supported
macOS	✅ Supported
Linux	✅ Supported

---

🧪 Testing

Run tests:

dart test

With coverage:

dart test --coverage=coverage

---

📄 License

BSD-2-Clause License. See LICENSE for details.

---

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.rst for guidelines.

---

📞 Support

• Issues: GitHub Issues
• Documentation: Main README
• Python version: PyPI
• TypeScript version: NPM

---

🌟 Related Packages

• Python: pip install catalogmx
• TypeScript/Node.js: npm install catalogmx
• Dart/Flutter: flutter pub add catalogmx (this package)

All three versions maintain 100% API compatibility and identical validation algorithms.