sealed_currencies 2.5.0

sealed_currencies: ^2.5.0 copied to clipboard

NEW FEATURES

• This version introduces named (Dart 3.10 dot-shorthand compatible) constructors for ISO classes, refactoring the ISO data files to use a factory constructor pattern with extension types. The changes transform the direct constructor calls into a more structured factory-based approach while maintaining backward compatibility. For example, instead of using FiatEur(), you can now use FiatCurrency.eur(). This change enhances code readability and aligns with modern Dart practices.

const currency = FiatEur(); // Old way (still supported).
const currency = FiatCurrency.eur(); // New way, or just .eur() in Dart 3.10.

print([FiatCurrency.eur(), FiatCurrency.usd()]); // Collections, 3.9 way.
// You can also use the new dot-shorthand syntax introduced in Dart 3.10:
print(<FiatCurrency>[.eur(), .usd()]); // Collections, 3.10 way.

REFACTOR

• Marked permissive constructors and translation-related parameters as deprecated; deprecated a translation interface and related extension methods.

CHORE

• Enable and fix 10 new Dart Code Metrics rules (from the 1.32.0: October Update).

NEW FEATURES

• Adds support for XCG (Caribbean Guilder) and ZWG (Zimbabwean Gold) currencies with translations (across 100+ locales each).
• Deprecates ANG, BGN, and ZWL currencies with appropriate migration paths.

FIX

• Corrected English currency name for KGS to "Kyrgyzstani Som".
• Corrected English currency name for GYD to "Guyanese Dollar".

DOCUMENTATION

• Improved documentation in README.

CHORE

• The Dart SDK was bumped to v3.9.2.

FIX

• Corrected subunitToUnit value for Hungarian Forint.

NEW FEATURES

• Updated language metadata to better reflect writing systems and script directionality for many languages.

REFACTOR

• Marked certain currencies as deprecated and updated related comments.
• Corrected country and language associations in documentation for currencies and languages.
• Standardized code normalization using new ISO code extension types, replacing older string and object extension methods.
• Deprecated legacy constant lists in favor of centralized static lists for ISO classes.
• Deprecated functional-style pattern matching methods and boolean type-check getters across ISO/sealed models. Users are advised to use switch expressions or direct equality/type checks instead.
• Deprecated extensions providing is* getters in favor of direct type checks.
• Standardized method return types for map serialization to use stronger, standard Dart Map types.
• Simplified code by removing redundant comments and improving null-aware syntax usage.

CHORE

• The Dart SDK was bumped to v3.8.1.
• Refined static analysis and linting rules, including enabling and disabling specific Dart Code Metrics rules.

DOCUMENTATION

• Improved formatting, fixed typos, and updated usage examples in README.

TEST

• Removed outdated test files related to deprecated APIs.
• Added or updated test cases to cover new behaviors and deprecation handling.

NEW FEATURES

• Enhance ISO standardized classes with Comparable interface and update bool getters.
• Add regional code alias and new ISO standardized extensions for type checking.
• Update symbol for Sudanese pound to "ج.س".

CHORE

• The Dart SDK was bumped to v3.8.0.
• Code has been formatted with the new Dart formatter.

REFACTOR

• Make copy-with extensions generic for ISO standardized classes.

DOCUMENTATION

• Improved documentation in README.
• Update dartdoc in ISO standardized classes instances to use backticks.

TEST

• Add tests for comparable boolean getters in ISO standardized classes.
• Add unit tests for regional code and ISO standardized extensions.

REFACTOR

• Nullable maybeCommonNameFor method now accepts nullable mainLocale parameter - if null is provided, null will be returned.

REFACTOR

• Improved generics handling in localization methods.
• Update and use stable L10N package.

DOCUMENTATION

• Improved documentation and example.
• Fixed typos in the README.

🎉 Second anniversary and new major release!

NEW FEATURES

• Introduced new methods for working with common names and common name maps: commonNamesMap on ISO collections and commonNameFor/maybeCommonNameFor on ISO objects. These methods are significantly faster than the old translations - related methods because they work directly with locale-specific maps instead of iterating through all translations of each ISO object.
• The translations getter is now a computed field. This means it will only generate the translations when they are requested, rather than storing them all in memory. It's recommended to cache the results of the getter to avoid redundant calculations. Because of that - translation and maybeTranslation methods are no longer recommended for retrieving localization data.
• The commonNamesCacheMap is deprecated because it relies on the memory-intensive translations getter.
• New localization delegates on IsoTranslated objects simplify complex queries for object localizations.
• Bool getters on IsoStandardized objects can now be applied to null values. For example, maybeIso.isRub will return false if maybeIso is null, without the need for additional null-checks.

BREAKING CHANGES

• The package now requires Dart v3.6.0 or higher.
• The IsoTranslated<T, N, L> class now uses three generic types instead of two. If you used this class directly in your code, simply add the additional generic <L extends BasicLocale> to your reference.
• The default toString() implementation of BasicLocale now uses Flutter's Locale-like output format. You can still access the old output by setting the short flag to false.
• The sealed_currency_translations library is deprecated. Migrate to the l10n_currencies package or use l10n getter in ISO objects that provides the same data without holding all translations in memory. This sub-library and its content (except for supported locales lists - they will be moved to the main library) will be removed in the next major package version.

NEW FEATURES

• Improvements of toString() method implementations in models and addressing new lints + DCM reports.
• Added "polski" to the Polish language's namesNative array.

This is the last minor version update with significant changes for some time. The next steps will be patches at most. Currently working on sealed_countries (and world_countries) v2.0.0 which will bring new data and a big feature there, very likely without breaking the existing API.

NEW FEATURES

• 🎉 All translations in the eco-system packages now support all GlobalMaterialLocalizations and GlobalCupertinoLocalizations locales.
• The locale parameter in the maybeTranslation method is now nullable.
• The permissive constructors are now even more permissive, only name and code parameters remain required.

NEW FEATURES

• 🦾 Language translations now also support all GlobalMaterialLocalization + GlobalCupertinoLocalizations locales.
• Added new internationalName getter in IsoStandardized interface, representing the international name of the ISO object.
• Added new UpperCaseMap class, that UpperCaseIsoMap extends, a simple version of UpperCaseIsoMap without key length checks and IsoStandardized values requirement.
• Added new BasicLocale class, that TranslatedName extends. Representing a type-safe world locale (language, country/region code and script).
• Added new commonNamesCacheMap method for all ISO based sealed classes collections, which allows to create a cache map of common names translations for the given BasicLocale.

BREAKING CHANGES

Because of the BasicLocale changes (described above), translation() and maybeTranslation() methods on the Translated classes now require BasicLocale input. If you are not using those methods directly, then you don't need to change anything, otherwise you will need to do small adjustment - wrap the content of those methods with a BasicLocale.

Before:

print(iso?.maybeTranslation(LangPor()));

After:

print(iso?.maybeTranslation(BasicLocale(LangPor())));

Or just:

1. Enable Regular Expressions in your IDE's Find and Replace panel.
2. In the Find field, enter the regex: (translation\()(.*)(\))
3. In the Replace field, enter: $1BasicLocale($2)$3
4. Execute the replace operation.

NEW FEATURES

• Fix thousands separator for CHF.
• codeOther is no longer nullable (in all IsoStandardized classes).
• Added new compile-time constant and case-insensitive code maps (UpperCaseIsoMaps) in every ISO class (accessible as static constants via .map, .codeMap, .codeNumericMap etc.).
• Factory constructors and methods now using those maps if no (optional) array is provided there.
• Factory constructors and methods in IsoStandardized classes now allow non-String inputs - any Object, for example you can now use StringBuffer or Enum instances directly:

 enum IsoEnum {de, fr, ar} // On .fromCode(IsoEnum.de) call it will use "DE" input.

or you can basically use any custom class with toString() override:

class CustomIsoCodeClass {
 const CustomIsoCodeClass({String code = '123', this.foo}) : _code = code;
 final String _code;
 final Foo? foo;

 @override
 String toString() => _code; // Has to override toString() with ISO value.
}

// On .fromAnyCode(CustomIsoCodeClass(code: ' 321 ')) call it will use "321" input.

REFACTOR

• Refactored asserts in maybeMapIsoCode method.
• Fixed typos in CHANGELOG and README.

NEW FEATURES

• Added new static maybeFrom* methods and refactored old ones. They are also now accept any Object? input instead of just String?.
• Added new and refactored old tests with a performance in mind.
• Added new firstIsoWhere* extensions on ISO iterables.
• Added is* boolean getters for example:

if (isoObject.isUsd) return _onUsDollar();

is more readable and shorter equivalent of this check:

if (isoObject == const FiatUsd()) return _onUsDollar();

NEW FEATURES

• Added new constructor called permissive - which allow the creation of custom class instances that are not fully compatible with the ISO standard.
• Translated class is now sealed - which means you can now directly compare instances of different ISO classes directly (for example in switch statements).

🎉 First anniversary and first stable release!

NEW FEATURES

• Added new getter for TranslatedName name called common, which might be useful in some cases when name is being used by a parent class.
• Added a lot of translations from the Symfony.
• 🦾 Currencies translations now support all GlobalMaterialLocalizations + GlobalCupertinoLocalizations locales.
• Updated LICENSE.

BREAKING CHANGES

• Removed code marked as Deprecated in previous releases.
• Replaced old FiatCurrency.list with a new FiatCurrency.listExtended.
• Removed FiatCurrency.regularList (please use FiatCurrency.list instead).
• Marked Croatian Kuna as Deprecated.

NEW FEATURES

• Added new interface IsoTranslated which combines Translated and IsoStandardized interfaces.
• Added standard* static constants in the FiatCurrency class referencing different names of the ISO 4217 standard.
• Improved documentation in README, added FAQ.
• Updated example with translations.

NEW FEATURES

• Added new factory to FiatCurrency - fromAnyCode, which do the length and type checks and redirects to other fromCode\* constructors
• Added new static method to FiatCurrency - maybeFromAnyCode, which works same way as fromAnyCode, but doesn't throws StateErrors if no currency object is found.
• Added maybeMapIsoCode method to String extensions, which is used under the hood of (maybe)fromAnyCode.

REFACTOR

• Named classes now has boolean flag (short, defaults to true).
• TranslatedName class by default returns .name value on toString().
• Refactored dollar symbols in toString() methods.

NEW FEATURES

• Added regularList getter for the list of regular currencies (excludes 10 currencies from the specialPurposeList).
• FiatCurrency class now contains translations of language name to other languages (79 translations for each language minimum).
• Those translations are also accessible from the translation and maybeTranslation methods.
• Refactored factory constructors - there is an optional parameter to provide custom list.
• Added TranslatedName class for the translations.
• Implement new abstract interfaces for currencies: Named and Translated.

FIX

• Fixed several English currency names.

NEW FEATURES

• Added copyWith, toJson etc. to the FiatCurrency, NaturalLanguage classes.
• Added new interfaces (IsoStandardized, JsonEncodable) and typedef (JsonMap) to the model.

FIX

• Fixed the alternate symbols list for the Scandinavian countries.
• Fixed the names native list for Sindhi in the data.

REFACTOR

• Factory constructors and static methods for data classes creation now implicitly trimming and comparing uppercase string inputs.
• Fixing old ignores and new linter rules.
• Updates in dev_dependencies.

FIX

• Zimbabwean Dollar (ZWL) is now properly placed as last item in currencies list.

REFACTOR

• Updates in dev_dependencies.

DOCUMENTATION

• Provided structure screenshot.

TEST

• Increase code coverage to 100%.

DOCUMENTATION

• Provided code coverage links and badge.

• Initial release.