README.md

Phone number mask parser

☎️ The package provides a simple parsing of phone numbers and various masking options.

Motivation

Some server APIs provide unformatted phone numbers, while the application client must figure out what mask to apply to a given phone number and use it for display.

Benefits

Some packages only provide the ability to either parse phone numbers, without the ability to apply a custom mask, or are formatters for fields from which logic cannot be extracted for use on non-field strings.
This package can use for self phone field formatters.
In the list of constant countries, such data is collected to ensure the maximum match for parsing phone numbers.

Efficiency

Determining the country by the potential telephone code using hash table - O(1).
Overlaying a target or recognized country mask - O(N).
(N - length of the recognized phone number string)

Phone code list

The list of countries and phone codes used may not contain all combinations of alternative codes for recognition.
If you are sure that your phone number and alternative code are definitely used in the desired country, inform the package developer.

Usage

Main Class

The package has the only main class to use - PhoneNumberMaskParser: The used masks must be formatted with "#" symbol, for example: "+## (##) ####".

const PhoneNumberMaskParser phoneNumberMaskParser = PhoneNumberMaskParser(
    targetMask: "+## #### ######",
    defaultMask: "+### (###) ### ####",
    isPlus: false,
    isEndless: true,
);

Data type	Name	Description	Default value
String?	targetMask	The mask that will be used to bypass phone number parsing to overlay all phone numbers. Use this field to use only one mask for all phone numbers.	null
String?	defaultMask	The mask that will be used in case the phone number is not recognized. If this field is not specified, the class will use the default mask "+### ### #### ####".	"+### ### #### ####"
bool	isPlus	The flag responsible for the plus sign at the very beginning.	true
bool	isEndless	the flag that doesn't cut the last part of the phone number if it exceeds the length of the mask.	false

Main Method

The main method apply does all the masking or parsing work.

Parsing

If the target mask is not specified, then the method works in number parsing mode:

  const PhoneNumberMaskParser phoneNumberMaskParser = PhoneNumberMaskParser();
  final PhoneNumberMaskParserResult result = phoneNumberMaskParser.apply(
    phoneNumber: "4492330323912034",
  );
  print(result.phoneNumberMasked); // +44 9233 032391
  print(result.country?.title); // United Kingdom
  print(result.country?.iso2Code); // GB
  print(result.country?.phoneCode); // 44
  print(result.country?.alternativePhoneCodes); // []
  print(result.country?.mask); // +## #### ######

Masking

To apply your own mask, specify the target mask:

  const PhoneNumberMaskParser phoneNumberMaskParser = PhoneNumberMaskParser(
    targetMask: "+## ## (####) ####",
  );
  final PhoneNumberMaskParserResult result = phoneNumberMaskParser.apply(
    phoneNumber: "930293023049495565",
  );
  print(result.phoneNumberMasked); // +93 02 (9302) 3049
  print(result.country); // null

Result

The result is a separate class PhoneNumberMaskParserResult that provides the following fields:

Data type	Name	Description
String	phoneNumberMasked	Formatted phone number in mask.
PhoneNumberMaskParserCountry?	country	Country of parsered phone number.

Country of parsered phone number PhoneNumberMaskParserCountry:

Data type	Name	Description
String	title	Name of the country of the phone.
String	iso2Code	Country code according to ISO 3166 standard.
String	phoneCode	Phone country code.
List	alternativePhoneCodes	Alternative phone country code.
String	mask	The mask of this number in its pure form.

Additional Objects

Additionally, the package provides a constant list of country objects for its own use - PhoneNumberMaskParserConstant.countries.

Additional Information

For more details see example project.
And feel free to open an issue if you find any bugs or errors or suggestions for adding to phone number parsing or phone countries data.