Skip to content

feat: add international auto-detect mode to PhoneNumberTransformer #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
janicduplessis merged 1 commit into from
Jun 18, 2026
Merged

feat: add international auto-detect mode to PhoneNumberTransformer #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions scripts/generate-phone-data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,17 @@ function generate(): string {
lines.push('];');
lines.push('');

// Calling code -> ISO country codes (primary country first). Used to detect
// the country from a typed international calling code.
lines.push(
'export const COUNTRY_CALLING_CODES: Record<string, string[]> = {',
);
for (const [code, isos] of Object.entries(callingCodes)) {
lines.push(` ${JSON.stringify(code)}: ${JSON.stringify(isos)},`);
}
lines.push('};');
lines.push('');

return lines.join('\n');
}

Expand Down
48 changes: 47 additions & 1 deletion src/formatters/__tests__/PhoneNumberTransformer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { PhoneNumberTransformer } from '../phone-number';
import { PhoneNumberTransformer, detectCountry } from '../phone-number';

// Helper to call the transformer worklet with simpler API
const transform = (
Expand Down Expand Up @@ -334,4 +334,50 @@ describe('PhoneNumberTransformer', () => {
expect(deResult?.value).toBe('+49 30 1234567');
});
});

describe('international mode', () => {
const intl = new PhoneNumberTransformer({ international: true });

it('formats a US number typed with +1', () => {
expect(transform(intl, '+14155552671')?.value).toBe('+1 (415) 555-2671');
});

it('switches to French formatting when +33 is typed', () => {
expect(transform(intl, '+33612345678')?.value).toBe('+33 6 12 34 56 78');
});

it('keeps a French trunk 0 when typed in full', () => {
expect(transform(intl, '+330612345678')?.value).toBe(
'+33 06 12 34 56 78',
);
});

it('switches to UK formatting when +44 is typed', () => {
expect(transform(intl, '+447911123456')?.value).toBe('+44 7911 123456');
});

it('shows just the calling code while it is the only thing typed', () => {
expect(transform(intl, '+44')?.value).toBe('+44');
});

it('ignores the `country` option and follows the typed code', () => {
const intlUs = new PhoneNumberTransformer({
international: true,
country: 'US',
});
expect(transform(intlUs, '+447911123456')?.value).toBe('+44 7911 123456');
});
});

describe('detectCountry', () => {
it('resolves the primary country from the calling code', () => {
expect(detectCountry('+1 415 555 2671')).toBe('US');
expect(detectCountry('+44 7911 123456')).toBe('GB');
expect(detectCountry('+33 6 12 34 56 78')).toBe('FR');
});

it('returns undefined when no calling code is recognized', () => {
expect(detectCountry('')).toBeUndefined();
});
});
});
235 changes: 235 additions & 0 deletions src/formatters/phone-data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5547,16 +5547,16 @@
};

export const COUNTRY_LIST: CountryPhoneData[] = [
COUNTRY_PHONE_DATA['AF']!,

Check warning on line 5550 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AF"] is better written in dot notation
COUNTRY_PHONE_DATA['AX']!,

Check warning on line 5551 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AX"] is better written in dot notation
COUNTRY_PHONE_DATA['AL']!,

Check warning on line 5552 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AL"] is better written in dot notation
COUNTRY_PHONE_DATA['DZ']!,

Check warning on line 5553 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["DZ"] is better written in dot notation
COUNTRY_PHONE_DATA['AS']!,

Check warning on line 5554 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AS"] is better written in dot notation
COUNTRY_PHONE_DATA['AD']!,

Check warning on line 5555 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AD"] is better written in dot notation
COUNTRY_PHONE_DATA['AO']!,

Check warning on line 5556 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AO"] is better written in dot notation
COUNTRY_PHONE_DATA['AI']!,

Check warning on line 5557 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AI"] is better written in dot notation
COUNTRY_PHONE_DATA['AG']!,

Check warning on line 5558 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AG"] is better written in dot notation
COUNTRY_PHONE_DATA['AR']!,

Check warning on line 5559 in src/formatters/phone-data.ts

View workflow job for this annotation

GitHub Actions / lint 

["AR"] is better written in dot notation
COUNTRY_PHONE_DATA['AM']!,
COUNTRY_PHONE_DATA['AW']!,
COUNTRY_PHONE_DATA['AC']!,
Expand Down Expand Up @@ -5793,3 +5793,238 @@
COUNTRY_PHONE_DATA['ZM']!,
COUNTRY_PHONE_DATA['ZW']!,
];

export const COUNTRY_CALLING_CODES: Record<string, string[]> = {
'1': [
'US',
'AG',
'AI',
'AS',
'BB',
'BM',
'BS',
'CA',
'DM',
'DO',
'GD',
'GU',
'JM',
'KN',
'KY',
'LC',
'MP',
'MS',
'PR',
'SX',
'TC',
'TT',
'VC',
'VG',
'VI',
],
'7': ['RU', 'KZ'],
'20': ['EG'],
'27': ['ZA'],
'30': ['GR'],
'31': ['NL'],
'32': ['BE'],
'33': ['FR'],
'34': ['ES'],
'36': ['HU'],
'39': ['IT', 'VA'],
'40': ['RO'],
'41': ['CH'],
'43': ['AT'],
'44': ['GB', 'GG', 'IM', 'JE'],
'45': ['DK'],
'46': ['SE'],
'47': ['NO', 'SJ'],
'48': ['PL'],
'49': ['DE'],
'51': ['PE'],
'52': ['MX'],
'53': ['CU'],
'54': ['AR'],
'55': ['BR'],
'56': ['CL'],
'57': ['CO'],
'58': ['VE'],
'60': ['MY'],
'61': ['AU', 'CC', 'CX'],
'62': ['ID'],
'63': ['PH'],
'64': ['NZ'],
'65': ['SG'],
'66': ['TH'],
'81': ['JP'],
'82': ['KR'],
'84': ['VN'],
'86': ['CN'],
'90': ['TR'],
'91': ['IN'],
'92': ['PK'],
'93': ['AF'],
'94': ['LK'],
'95': ['MM'],
'98': ['IR'],
'211': ['SS'],
'212': ['MA', 'EH'],
'213': ['DZ'],
'216': ['TN'],
'218': ['LY'],
'220': ['GM'],
'221': ['SN'],
'222': ['MR'],
'223': ['ML'],
'224': ['GN'],
'225': ['CI'],
'226': ['BF'],
'227': ['NE'],
'228': ['TG'],
'229': ['BJ'],
'230': ['MU'],
'231': ['LR'],
'232': ['SL'],
'233': ['GH'],
'234': ['NG'],
'235': ['TD'],
'236': ['CF'],
'237': ['CM'],
'238': ['CV'],
'239': ['ST'],
'240': ['GQ'],
'241': ['GA'],
'242': ['CG'],
'243': ['CD'],
'244': ['AO'],
'245': ['GW'],
'246': ['IO'],
'247': ['AC'],
'248': ['SC'],
'249': ['SD'],
'250': ['RW'],
'251': ['ET'],
'252': ['SO'],
'253': ['DJ'],
'254': ['KE'],
'255': ['TZ'],
'256': ['UG'],
'257': ['BI'],
'258': ['MZ'],
'260': ['ZM'],
'261': ['MG'],
'262': ['RE', 'YT'],
'263': ['ZW'],
'264': ['NA'],
'265': ['MW'],
'266': ['LS'],
'267': ['BW'],
'268': ['SZ'],
'269': ['KM'],
'290': ['SH', 'TA'],
'291': ['ER'],
'297': ['AW'],
'298': ['FO'],
'299': ['GL'],
'350': ['GI'],
'351': ['PT'],
'352': ['LU'],
'353': ['IE'],
'354': ['IS'],
'355': ['AL'],
'356': ['MT'],
'357': ['CY'],
'358': ['FI', 'AX'],
'359': ['BG'],
'370': ['LT'],
'371': ['LV'],
'372': ['EE'],
'373': ['MD'],
'374': ['AM'],
'375': ['BY'],
'376': ['AD'],
'377': ['MC'],
'378': ['SM'],
'380': ['UA'],
'381': ['RS'],
'382': ['ME'],
'383': ['XK'],
'385': ['HR'],
'386': ['SI'],
'387': ['BA'],
'389': ['MK'],
'420': ['CZ'],
'421': ['SK'],
'423': ['LI'],
'500': ['FK'],
'501': ['BZ'],
'502': ['GT'],
'503': ['SV'],
'504': ['HN'],
'505': ['NI'],
'506': ['CR'],
'507': ['PA'],
'508': ['PM'],
'509': ['HT'],
'590': ['GP', 'BL', 'MF'],
'591': ['BO'],
'592': ['GY'],
'593': ['EC'],
'594': ['GF'],
'595': ['PY'],
'596': ['MQ'],
'597': ['SR'],
'598': ['UY'],
'599': ['CW', 'BQ'],
'670': ['TL'],
'672': ['NF'],
'673': ['BN'],
'674': ['NR'],
'675': ['PG'],
'676': ['TO'],
'677': ['SB'],
'678': ['VU'],
'679': ['FJ'],
'680': ['PW'],
'681': ['WF'],
'682': ['CK'],
'683': ['NU'],
'685': ['WS'],
'686': ['KI'],
'687': ['NC'],
'688': ['TV'],
'689': ['PF'],
'690': ['TK'],
'691': ['FM'],
'692': ['MH'],
'850': ['KP'],
'852': ['HK'],
'853': ['MO'],
'855': ['KH'],
'856': ['LA'],
'880': ['BD'],
'886': ['TW'],
'960': ['MV'],
'961': ['LB'],
'962': ['JO'],
'963': ['SY'],
'964': ['IQ'],
'965': ['KW'],
'966': ['SA'],
'967': ['YE'],
'968': ['OM'],
'970': ['PS'],
'971': ['AE'],
'972': ['IL'],
'973': ['BH'],
'974': ['QA'],
'975': ['BT'],
'976': ['MN'],
'977': ['NP'],
'992': ['TJ'],
'993': ['TM'],
'994': ['AZ'],
'995': ['GE'],
'996': ['KG'],
'998': ['UZ'],
};
Loading
Loading