flutter_cep2 1.0.2
flutter_cep2: ^1.0.2 copied to clipboard
A Brazilian ZIP code (CEP) lookup library for Dart and Flutter applications. Supports multiple output formats including JSON and XML.
Changelog #
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
1.0.2 - 2025-08-07 #
📖 Documentation #
- Added comprehensive Code of Conduct (CODE_OF_CONDUCT.md)
- Added detailed Contributing Guidelines (CONTRIBUTING.md)
- Enhanced project documentation for better community engagement
- Improved development setup instructions
- Added GitHub Sponsors funding link for project support
1.0.1 - 2025-08-07 #
📖 Improved #
- Enhanced example application to better demonstrate plugin usage
- Updated example UI and user experience for clearer functionality showcase
- Improved example code documentation and comments
1.0.0 - 2025-08-07 #
✨ Added #
- Complete rewrite with modern Dart practices and null safety
- Comprehensive error handling with custom
CepException
- New
FlutterCep2
class with proper naming conventions (PascalCase) - Support for dependency injection with custom HTTP client
dispose()
method for proper resource cleanup- Enhanced API with enum for output formats (
CepOutputFormat
) - Full documentation with dartdoc comments
- Comprehensive test suite with 100% coverage
- Support for various ZIP code formats (with/without formatting)
- Immutable
Cep
model with properequals
andhashCode
- Platform support declarations for all platforms
- Topics and metadata in pubspec.yaml
🔧 Changed #
- Updated minimum Dart SDK version to 2.17.0
- Migrated from
pedantic
tolints
package for better code quality - Updated all dependencies to latest versions
- Improved error messages and exception handling
- Better input validation for ZIP codes
- Enhanced code organization and structure
🚨 Breaking Changes #
- Renamed main class from
flutter_cep2
toFlutterCep2
(PascalCase) - Renamed model class from
CEP
toCep
(PascalCase) - Changed output parameter from
String
toCepOutputFormat
enum - Updated method signatures and return types
- Removed support for 'piped' and 'querty' formats (never implemented)
📖 Documentation #
- Completely rewritten README with comprehensive examples
- Added API reference documentation
- Included Flutter widget example
- Added troubleshooting and contribution guidelines
- Enhanced library documentation
🧪 Testing #
- Added comprehensive test suite with mock HTTP client
- Tests for all error scenarios and edge cases
- Tests for different input/output formats
- Continuous integration improvements