p-hatan / mirrormirror.p-hatan.com

Viewing version 9.0.28. Open the latest package page.

phone_numbers_parser

9.0.28

Dart library for parsing phone numbers. Inspired by Google's libphonenumber and PhoneNumberKit for ios.

Download archive

Readme

Phone Numbers Parser

Dart library for parsing phone numbers. Inspired by Google's libphonenumber and PhoneNumberKit for ios.

The advantage of this lib instead of libphonenumber is that it instantly supports all platforms (no need for channeling).

Features

  • Validation: Validate based on type (mobile, fixed line, voip)
  • Formatting: Format phone number for a specific country
  • Phone ranges: find all phone numbers in a range of phone numbers
  • Find phone numbers in a text
  • Supports eastern arabic digits
  • Uses best-in-class metadata from Google's libPhoneNumber project.

Demo

demo

Contributing

Please read this to upgrade the metadata

Usage

Use the class PhoneNumber as a starting point

import 'package:phone_numbers_parser/phone_numbers_parser.dart';

void main(List<String> arguments) {
  final frPhone0 = PhoneNumber.parse('+33 655 5705 76');
  // raw caller in france calling another person in france
  final frPhone1 =
      PhoneNumber.parse('0 655 5705 76', callerCountry: IsoCode.FR);
  // us calling to france
  final frPhone2 =
      PhoneNumber.parse('011 33 655-5705-76', callerCountry: IsoCode.US);
  final frPhone3 =
      PhoneNumber.parse('011 33 655 5705 76', destinationCountry: IsoCode.FR);
  final isAllEqual =
      frPhone0 == frPhone1 && frPhone0 == frPhone2 && frPhone0 == frPhone3;
  print(frPhone1);
  print('all raw same: $isAllEqual');

  // validation
  final valid = frPhone1.isValid();
  final validMobile = frPhone1.isValid(type: PhoneNumberType.mobile);
  final validFixed = frPhone1.isValid(type: PhoneNumberType.fixedLine);
  print('valid: $valid'); // true
  print('valid mobile: $validMobile'); // true
  print('valid fixed line: $validFixed'); // false

  // utils
  final text =
      'hey my phone number is: +33 939 876 218, but you can call me on +33 939 876 999 too';
  final found = PhoneNumber.findPotentialPhoneNumbers(text);
  print('found: $found');
}

validation

final valid = frPhone1.validate();
final validMobile = frPhone1.validate(type: PhoneNumberType.mobile);
final validFixed = frPhone1.validate(type: PhoneNumberType.fixedLine);
print('valid: $valid'); // true
print('valid mobile: $validMobile'); // true
print('valid fixed line: $validFixed'); // false

Formatting

Formatting is region specific, so the formats will vary by iso code to accommodate for local formats.

final phoneNumber =
    PhoneNumber.parse('2025550119', destinationCountry: IsoCode.US);
final formattedNsn = phoneNumber.formatNsn();
print('formatted: $formattedNsn'); // (202) 555-0119

Range

print('Ranges:');
final first = PhoneNumber.parse('+33 655 5705 00');
final last = PhoneNumber.parse('+33 655 5705 03');
final range = PhoneNumber.getRange(first, last);

print('Count: ${range.count}');
print('Expand: ${range.expandRange().join(',')}');

if (first > last) {
  print("this shouldn't be.");
}

final one = PhoneNumber.parse('+33 655 5705 01');
final two = PhoneNumber.parse('+33 655 5705 02');

if (one.isAdjacentTo(two)) {
  print('We are together');
}
if (one.isSequentialTo(two)) {
  print('$two comes after $one');
}

/// treat the phone no. like an int
final three = two + 1;
print('Its still a phone No. $three');
two - 1 == one;
final another = one + 2;
print('$another == $three');
Changelog

9.0.28

  • Fix multi digit group references ($10, $11, ...) being corrupted when a national number is transformed (a $10 reference used to be partially replaced by the $1 reference).
  • Throw a PhoneNumberException with Code.inputIsTooLong when a phone number contains more digits than the maximum supported length (country calling code plus national significant number).
  • Throw a PhoneNumberException with Code.invalid instead of Code.notFound when a phone number contains no digit at all.
  • Remove the unreachable fallback in the destination metadata lookup.
  • Rename the generated metadataLenghtsByIsoCode map to metadataLengthsByIsoCode (the misspelled name is kept as a deprecated alias).
  • Remove the unused Constants.slashSeparatedDates.
  • Add a round trip test suite covering every metadata example number, and a test asserting no country calling code is the prefix of another one.

9.0.27

  • Upgrade metadata

9.0.26

  • Upgrade metadata

9.0.25

  • Upgrade metadata

9.0.24

  • Upgrade metadata

9.0.23

  • Upgrade metadata

9.0.22

  • Upgrade metadata

9.0.21

  • Upgrade metadata

9.0.20

  • Upgrade metadata

9.0.19

  • Upgrade metadata

9.0.18

  • Upgrade metadata

9.0.17

  • Upgrade metadata

9.0.16

  • Upgrade metadata

9.0.15

  • Upgrade metadata

9.0.3

  • Upgrade metadata

9.0.2

  • Fix format for argentinian phone number

9.0.1

  • Fix wrong format for some countries

9.0.0

  • Added a format parameter to choose between international and national format
  • Format now uses the national format by default

8.3.0

  • added support for remaining phoneNumberTypes (thanks @cottonman132 )

8.2.2

  • update metadata

8.2.1

  • add demo link in readme

8.2.0

  • added VOIP support
  • udpated metadata
  • Removed MinMaxUtils that was unused internally. While exported publically it was undocumented.

8.1.3

  • deprectate getFormattedNsn in favor of formatNsn

8.1.2

  • lower meta dependency version for flutter compat

8.1.1

  • updated metadata

8.1.0

  • updated metadata
  • fix for local phone numbers not parsing accurately (issue 46)
  • phone numbers starting with the country code of the destination country will now return the phone number without the country code if the phone number is valid without it.
  • refactor some internal

8.0.0

  • made it easier to contribute
  • remove dependency on dart_countries and phone_number_metadata and instead work as a monorepo for easier contribution.
  • upgrade metadata

7.0.2

  • Changed behavior to not remove the country code from an incomplete phone number that did not start with an exit code.

7.0.1

  • Fix issue where international phone numbers would be transformed as if those were local ones.

7.0.0

This major introduces a more accurate parsing logic taking into account caller and destination country.

  • add parse method which takes as parameters callerCountry and destinationCountry
  • [Breaking]: removed most factory methods on PhoneNumber in favor of parse, see readme
  • [Breaking]: renamed validate and validateWithLength to isValid and isValidateLength
  • updated metadata
  • PhoneNumber.findPotentialPhoneNumbers now returns a list of phone number when scanning text.

6.0.1

  • please use 6.0.0 or upgrade to 7.0.0, this is a faulty version.
  • deprecated factories

6.0.0

  • [Breaking]: removed fromMap, toMap which have been replaced by fromJson(Map), toJson respectively.

5.0.5

  • improved readme

5.0.4

  • improved readme
  • upgraded deps

5.0.3

  • updated metadata

5.0.0

  • [Breaking] all iso code api now use IsoCode enum
  • fix for parseRaw when only country code is present.

4.2.1

  • make phone number json serializable

4.2.0

  • Fix incorrect parsing in some cases
  • fix validate length as it was incorrectly validating with pattern

4.1.0

  • only modify national number to its international version when it is valid
  • resolve issue where phone number were incorrectly parsed if national number started with country code (it happens)

4.0.1

  • reexport deprecated public api for backward comp

4.0.0 Consolidating Public API

This release removes the LightPhoneParser because it was not working perfectly and the cost of maintaining two parsers is too high.

Removing that parser allowed to revert to a more succint public API, where methods should be accessed solely via the PhoneNumber class.

PhoneParser, PhoneNumberFormatter and the likes are still exported for backward compatibility but it is advised to switch to PhoneNumber's methods instead

  • [Breaking]: LightPhoneParser has been removed as it was imperfect and added complexity in maintaining two parsers.
  • [Deprecated]: PhoneParser methods have been deprecated in favor of the methods on PhoneNumber class

3.0.2

  • fix formatter error when empty input

3.0.1

  • added [parseNational]

3.0.0

  • added localized formatter to format a phone number in an human readable way
  • added PhoneNumberRanges and utility operators on PhoneNumber (thanks @bsutton)
  • renamed [dialCode] to [countryCode] as dialCode was semantically incorrect

2.0.1

  • rename base class for parsers to BasePhoneParser, as parser was too broad.
  • export BasePhoneParser

2.0.0

  • Resolve issue #1 where it was possible to significantly increase memory foothprint by importing both parsers. Thanks @xvrh
  • Deplaced validate method from PhoneNumber to PhoneParser and LightPhoneParser to make it more obvious that one is
  • Light parser can now parseWithDialCode and parseRaw, although less accurate than the full parser

1.0.5

  • Minor doc change

1.0.4

  • Added metadata property runtime type to toString to make it more obvious when two instances are not equals

1.0.3

  • Made toString more readable

1.0.2

  • Add toString to PhoneNumber

1.0.1

  • validate method on PhoneNumber

1.0.0

  • There are now two parsers:

    • PhoneParser: Heavy, more accurate and more computationally intensive (relies on pattern matching)
    • LightPhoneParser: Light, somewhat accurate and less computationally intensive (relies on length) If a light validation based on length suffice, LightPhoneParser can be used, assuming you don't import the other parser, that will decrease the library size footprint.

    With this change a few breaking changes had to be made

  • [Breaking]: PhoneNumber creation is now made with parsers:

    before:

    final frPhone = PhoneNumber.fromRaw('+33 655 5705 76');
final frPhone1 = PhoneNumber.fromIsoCode('FR', '655 5705 76');

    after:

    final frPhone = PhoneParser.fromRaw('+33 655 5705 76')
final frPhone1 = LightPhoneParser.fromIsoCode('FR', '655 5705 76');

  • [Breaking]: removed country class and country list, which are now in a separate library

0.2.0

  • extracted country data files to another library dart_countries as it can be used in other scenarios
  • [Breaking]: Country.getDisplayDialCode is now a getter Country.displayIsoCode.

0.1.4

  • upgrade dependencies

0.1.3

  • deprecate valid property on phone number
  • make phone number type in validate method nullable to validate against general type

0.1.2

  • rename example so it shows in pub.dev

0.1.1

  • Add example

0.1.0

  • fix substantial bug where validity would be true for longer numbers
  • added validity check on phone number to further check validity for a given phone number type (mobile, fixedLine)
  • added more tests

0.0.5

  • Breaking: remove getters for leading digits as it sometimes contains patterns
  • Put space in American Samoa's name

0.0.4

  • changed displayDialCode getter into method to allow for different syntax

0.0.3

  • added toString to PhoneNumber
  • added leading digits getter to country
  • added displayDialCode on country which is a mix of country code and leading digits
  • added copyWithIsoCode as instance method on phone number to make it easy to switch between countries in a phone number input
  • added toString to exception

0.0.2

  • added some doc, by Cedvdb

0.0.1

  • Initial version, created by Cedvdb

Installing

export PUB_HOSTED_URL=https://pub.mirror.p-hatan.com
flutter pub add 'phone_numbers_parser:9.0.28'
pubspec.yaml
name: phone_numbers_parser
description: Dart library for parsing phone numbers. Inspired by Google's libphonenumber and PhoneNumberKit for ios.
version: 9.0.28
homepage: https://github.com/cedvdb/phone_number_parser

environment:
  sdk: ">=3.0.0 <4.0.0"

dependencies:
  meta: ^1.10.0

dev_dependencies:
  xml: ^6.5.0
  lints: ^3.0.0
  test: ^1.25.2

Version history

VersionPublishedArchiveSHA-256
0.0.1On demandDownload1a2688ea…aed1c5
0.0.2On demandDownload350f3648…286fee
0.0.3On demandDownload3e276a88…264013
0.0.4On demandDownloadf03e6201…4cde2a
0.0.5On demandDownload0dd2172b…21487d
0.1.0On demandDownload695a13af…a4d199
0.1.1On demandDownload0854b999…4fc752
0.1.2On demandDownload51e1a3a2…e0383e
0.1.3On demandDownloaddf296dc1…fba6b5
0.1.4On demandDownload24cf75d4…ac3f38
0.2.0On demandDownload447d6d74…0cb08f
1.0.0On demandDownload215f0add…08bd6f
1.0.1On demandDownload52519a13…b40927
1.0.2On demandDownload1e2694af…7ec4eb
1.0.3On demandDownload14e35c44…209e87
1.0.4On demandDownload43a999c3…d9cb58
1.0.5On demandDownload38292e53…2efa7f
2.0.0On demandDownload22d7929e…d0e7b8
2.0.1On demandDownloada4508a1a…532a46
3.0.0On demandDownloadac2adf13…c1b951
3.0.1On demandDownloadc3f46792…94ef86
3.0.2On demandDownloadc552a1f6…0d7e13
4.0.0On demandDownload46dd3ea0…f4d3d6
4.0.0+1On demandDownloade09e6441…4cc7c7
4.0.0+2On demandDownload69f3ff89…f38584
4.0.0+3On demandDownload34ebd0e8…11a6cd
4.0.0+4On demandDownload2f8aad9c…742fbc
4.0.0+5On demandDownload784b28e6…f47334
4.0.1On demandDownload570ee7f3…a07f7b
4.1.0On demandDownloadc51da42f…01e14f
4.2.0On demandDownload3fc01dfa…9c8bb9
4.2.1On demandDownload35eb7499…40ddf0
5.0.0On demandDownloadf1b1bfb5…89ca4a
5.0.3On demandDownload06a2f9e6…d2a066
5.0.4On demandDownloadd0b15a15…9450b4
5.0.5On demandDownloade9d0d990…db91f5
6.0.0On demandDownload315c544c…340742
6.0.1On demandDownloadc676fef3…cc3dc2
7.0.0On demandDownload9b41793a…d96661
7.0.0+1On demandDownload77f2ee17…40a1d9
7.0.1On demandDownloadc3b8946c…6be625
7.0.2On demandDownloada3659911…ba830d
8.0.0On demandDownload3b809c01…1576e5
8.1.0On demandDownload17a66863…49da02
8.1.1On demandDownloadae89206d…ec82f6
8.1.2On demandDownloadc36e71f6…9f3f80
8.1.3On demandDownloadd0dad4f5…eb964e
8.2.0On demandDownloadf7f972fe…ed1ce0
8.2.1On demandDownloadebe08725…c21e06
8.2.2On demandDownloadf6fed1ac…7c6784
8.3.0On demandDownload62451b68…22fae2
9.0.0On demandDownloadaf2fe52a…46044a
9.0.1On demandDownloadaf9756bd…de00dc
9.0.2On demandDownload75986ce6…57cc74
9.0.3On demandDownload8aaa4970…ac5d9b
9.0.11On demandDownload87b2c344…ac6f02
9.0.15On demandDownloadf95f1549…623c01
9.0.16On demandDownloadcfd5217c…e47eed
9.0.17On demandDownload95fe667c…032e37
9.0.18On demandDownloadca0e0ddb…b1b120
9.0.19On demandDownload2c9b190a…4b6375
9.0.20On demandDownloadc30ec1a8…ce5e95
9.0.21On demandDownloade6157143…33f03b
9.0.22On demandDownload8e51d32c…06fe41
9.0.23On demandDownload330656e2…0235d2
9.0.24On demandDownloadf024c400…ea5a31
9.0.25On demandDownloadf0d669e9…bb19c7
9.0.26On demandDownload5c4367d9…c3026a
9.0.27On demandDownload3177c2d3…2fc681
9.0.28Cached · Upstream SHA-256 matchedDownload911410b1…ef4923

Dependencies

meta "^1.10.0"