minted 1.0.0
minted: ^1.0.0 copied to clipboard
Well-modelled Dart value types (email, IBAN, and more) built on parse-don't-validate, so every instance is guaranteed well-formed. Pure Dart.
minted gives you real types for the values you'd usually keep in a String and hope for the
best: emails, IBANs, phone numbers, and more. Every type is built on parse, don't validate: the
parser is the only door in, so anything that came through it is well-formed by construction. Once
you hold an Email, it is a valid email. No more carrying "is this string actually valid?" three
functions deep. (One asterisk on that, see Caveats.)
It's pure Dart, so it runs everywhere Dart does: Flutter apps, servers, CLIs, and the web. And every type wears the same small API, so learning one teaches you the rest.
Why "parse, don't validate"?
A validator takes a String, checks it, and hands the same String back, so every function
downstream has to trust the check happened, or re-check it. A parser takes a String and returns a
different type that can only exist if the input was well-formed. Validity becomes a fact of the
type system: checked once, carried everywhere.
That's what int.parse and Uri.parse already do, and it's what every minted type does for its
domain. String email, String phone, String name are three interchangeable, mixed-up-able
parameters; Email, PhoneNumber, PersonName are not.
The phrase comes from Alexis King's essay, Parse, don't validate. It's written in Haskell, but nothing in the argument depends on that; it reads fine from Dart.
- Install
- A quick taste
- What's in the box
- One shape, every type
- Handling failures
- Caveats
- Roadmap
- Contributing
Install #
dart pub add minted
A quick taste #
final email = Email.tryParse('Jane.Doe@Example.COM')!;
email.value; // 'Jane.Doe@example.com' (domain lower-cased for you)
email.domain; // 'example.com'
Email.tryParse('not-an-email'); // null, nothing thrown
What's in the box #
Grouped by domain sector, the same way the source is laid out under lib/src/.
Contact #
| Type | What it guarantees | Standard |
|---|---|---|
Email |
a well-formed address, domain lower-cased | RFC 5322 |
PhoneNumber |
a valid number, stored in E.164 | ITU-T E.164 |
Finance #
| Type | What it guarantees | Standard |
|---|---|---|
Iban |
structure, country length, and the mod-97 checksum | ISO 13616 |
Chronology #
| Type | What it guarantees | Standard |
|---|---|---|
Date |
a real calendar date: no time, no zone; impossible dates rejected | ISO 8601 |
Month |
a real month 1-12 that knows its own length (leap-aware) |
building block |
Identifiers #
| Type | What it guarantees | Standard |
|---|---|---|
Uuid |
a well-formed UUID; version and variant read back, Nil/Max recognised | RFC 9562 |
Numerics #
| Type | What it guarantees | Standard |
|---|---|---|
Digit / Digits |
a single digit 0-9, or an iterable sequence of them |
building block |
Everything checks the real standard, not just the shape: Iban actually runs the mod-97 checksum
and Email the full RFC 5322 grammar. A regex that only looks right isn't enough.
One shape, every type #
Learn one type and you've learned them all. Each one gives you:
Type.tryParse(input)returns the value, ornullwhen the input isn't validType.parse(input)returns aParseOutcome: either the value, or a typedfailurefrom that type's own vocabulary (IbanFailure,DateFailure, …). Nothing is thrown, so you canswitchon the cause, or read.reasonOrNullfor a form-field message- value equality:
a == bcompares content, not identity - a canonical form to read back (
.valueon most types,.asStringonDigits), normalised on parse so equal values really are equal - an assembly factory for parts you assert are valid (
fromComponents,from,of). These do throwMintedFormatException, which extendsFormatException, because calling one is you claiming the parts are good - getters that fit the type:
email.domain,iban.checkDigits,phone.nationalNumber
More examples
final iban = Iban.tryParse('gb29 nwbk 6016 1331 9268 19')!;
iban.value; // 'GB29NWBK60161331926819' (compact)
iban.countryCode; // 'GB'
iban.checkDigits; // (first: Digit, second: Digit)
iban.formatted; // 'GB29 NWBK 6016 1331 9268 19' (grouped paper form)
final phone = PhoneNumber.tryParse('0 655 5705 76', region: 'FR')!;
phone.value; // '+33655570576' (E.164)
phone.type; // PhoneNumberType.mobile
phone.nationalNumber; // Digits(655570576) (an Iterable<Digit>)
phone.telUri; // tel:+33655570576
// national-format input takes a region hint; international ('+…') input doesn't:
PhoneNumber.tryParse('0 655 5705 76'); // null (no region given)
// Date: the calendar date DateTime doesn't model (no time, no zone):
final date = Date.tryParse('2026-07-07')!; // strict ISO 8601 YYYY-MM-DD
date.iso8601; // '2026-07-07' (canonical form)
date.weekday; // 2 (1 = Monday … 7 = Sunday)
date.month; // Month.july (a Month; date.month.daysIn(2026) is 31)
date.addDays(30); // Date(2026-08-06) (throws past the 0000-9999 bound)
date.tryAddDays(3000000); // null (the same walk, without the throw)
date < Date(2027); // true (Date(2027) is 2027-01-01)
// impossible dates are rejected, not rolled over the way DateTime does:
Date.tryParse('2026-13-01'); // null (no 13th month; DateTime would give 2027-01-01)
// Uuid: type an existing UUID (the `uuid` package generates them). Case, a urn:uuid: prefix,
// and surrounding braces are all normalised away:
final id = Uuid.tryParse('URN:UUID:F81D4FAE-7DEC-11D0-A765-00A0C91E6BF6')!;
id.value; // 'f81d4fae-7dec-11d0-a765-00a0c91e6bf6' (lower-cased, unwrapped)
id.version; // 1
id.variant; // UuidVariant.rfc9562
Uuid.tryParse('not-a-uuid'); // null
// build from parts you already trust (throws if they don't form a valid whole):
Iban.fromComponents(countryCode: 'GB', bban: 'NWBK60161331926819'); // computes the check digits
Email.fromComponents(localPart: 'jane', domain: 'example.com');
PhoneNumber.fromComponents(countryCode: '33', nationalNumber: Digits.tryParse('655570576')!);
Scope: what minted covers, and what it doesn't
minted fills the gap where no clean value type exists. It doesn't re-model what the SDK (Uri,
DateTime, BigInt) or strong packages (money2, intl) already cover well. Where a good
package already solves a piece, minted wraps it rather than reinventing: the email grammar, the IBAN
registry, and phone metadata all come from established packages.
Uuid is a value type, not a generator. The uuid package mints new UUIDs and hands you a
String; minted's Uuid types an existing one so it stops being a bare String a few functions
deep. They pair up: generate with uuid, then type the result with Uuid.
IBAN country coverage comes from iban_validator, which
tracks recent adoptions and includes some countries not yet in the formal ISO registry. You can
check a given country in its
data file.
Handling failures #
parse doesn't throw. It hands back a ParseOutcome: either the value, or a typed failure from
that type's own vocabulary. For a form field, reasonOrNull is the whole validator, because it's
null exactly when the input was good:
String? ibanError(String input) => switch (Iban.parse(input).reasonOrNull) {
null => null, // valid
IbanChecksumFailed() => 'Check the digits, one looks mistyped',
IbanUnknownCountry(:final countryCode) => 'We do not support IBANs from $countryCode',
IbanInvalidLength(:final expected) => 'An IBAN here is $expected characters',
_ => 'That does not look like an IBAN',
};
The vocabulary is sized to what the standard can actually distinguish, so it varies by type: Iban
has five variants, Date four, Email one. That last is the honest ceiling rather than a shortcut,
since the underlying validator reports only pass or fail, and a guessed "invalid domain" would be
worse than saying less. Switching is exhaustive per type, so adding a variant is a compile error at
your call site, not a silent gap.
Pattern-match the outcome itself when you want the value too:
switch (Iban.parse(input)) {
case ParseSuccess(:final value): send(value);
case ParseFailure(:final reason): log(reason.message);
}
Three other doors, when you don't need the reason:
| You want | Use | On failure |
|---|---|---|
| The value or nothing | Iban.tryParse(input) |
null |
| The value or a fallback | Iban.parse(input).getOrElse(() => …) |
the fallback |
| To assemble from parts you already trust | Iban.fromComponents(…) |
throws MintedFormatException |
That last row is the only thing in the package that throws, and deliberately: calling it is you
asserting the parts are valid, so a failure is a bug in your code rather than bad input. The
exception extends FormatException and carries the same typed failure.
Using an FP library? Three lines.
ParseOutcome is Either-shaped on purpose, but minted doesn't depend on an FP package: that
dependency would show up in every signature and force itself on everyone. Bridge it in your own app
instead. With ribs_core:
extension RibsOutcome<F extends MintedFailure, T> on ParseOutcome<F, T> {
Either<F, T> get either => fold(Either.left, Either.right);
ValidatedNel<F, T> get validated => fold(Validated.invalidNel, Validated.validNel);
}
The same shape works for any other FP library: fold is the exit.
Caveats #
Never cast into a minted type. The single-value types are extension types, which is what makes
them free: no allocation per value, and equality, hashCode and ordering inherited from the
representation. The price is that the type exists only at compile time, so a cast slips past the
parser and the compiler allows it.
'nope' as Email; // compiles, succeeds
json['email'] as Email; // same hole, where unvalidated input actually arrives
rawStrings as List<Email>; // a whole list at once, no per-element check
That Email blows up the moment you read .localPart. So parse, tryParse and fromComponents
are the only doors in, and a cast into a minted type is a bug. It's also the one place the
int.parse / Uri.parse comparison breaks down, since those return real classes that can't be
forged; worth saying out loud, because a package can't stop its callers from casting. A lint for it
is proposed in dart-lang/sdk#59310. The multi-part
types (Date, Digits) are ordinary classes, so bad casts throw there instead. Why the erasure is
a deliberate trade rather than an oversight:
APPENDIX.md.
Roadmap #
- ✅
Email(RFC 5322) - ✅
Iban(ISO 13616, mod-97) - ✅
PhoneNumber(E.164) - ✅
Date/Month(ISO 8601 calendar date, leap-aware month) - ✅
Digit/Digits(numeric building blocks) - ✅
Uuid(RFC 9562: parse, classify version/variant, Nil/Max sentinels) - ❌
Bic,CreditCardNumber(Luhn),Isbn,Ean/Gtin - Later: ISO code lists, bounded numerics, opt-in JSON /
fpdart/ Flutter companions
Contributing #
Issues and pull requests are welcome. If you're adding a type, hold it to the shared value-type
contract (parse-don't-validate, a private constructor, MintedFormatException, value equality) and
bring the official standard test vectors along.