@formatjs/utils 1.1.0 → 1.2.0

package/index.d.ts

@@ -1 +1,2 @@
-export { countryCodeAlpha3ToAlpha2 } from './src/countryCodes';
+export { canonicalizeCountryCode } from './src/countryCodes';
+export { defaultCurrency } from './src/defaultCurrency';

package/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.countryCodeAlpha3ToAlpha2 = void 0;
+exports.defaultCurrency = exports.canonicalizeCountryCode = void 0;
 var countryCodes_1 = require("./src/countryCodes");
-Object.defineProperty(exports, "countryCodeAlpha3ToAlpha2", { enumerable: true, get: function () { return countryCodes_1.countryCodeAlpha3ToAlpha2; } });
+Object.defineProperty(exports, "canonicalizeCountryCode", { enumerable: true, get: function () { return countryCodes_1.canonicalizeCountryCode; } });
+var defaultCurrency_1 = require("./src/defaultCurrency");
+Object.defineProperty(exports, "defaultCurrency", { enumerable: true, get: function () { return defaultCurrency_1.defaultCurrency; } });

package/lib/index.d.ts

@@ -1 +1,2 @@
-export { countryCodeAlpha3ToAlpha2 } from './src/countryCodes';
+export { canonicalizeCountryCode } from './src/countryCodes';
+export { defaultCurrency } from './src/defaultCurrency';

package/lib/index.js

@@ -1 +1,2 @@
-export { countryCodeAlpha3ToAlpha2 } from './src/countryCodes';
+export { canonicalizeCountryCode } from './src/countryCodes';
+export { defaultCurrency } from './src/defaultCurrency';

package/lib/src/countryCodes.d.ts

@@ -1 +1,6 @@
-export declare function countryCodeAlpha3ToAlpha2(alpha3?: string): string | undefined;
+/**
+ * Canonicalize a country code to a alpha2 country code (uppercase).
+ * @param alpha3OrAlpha2 - 2 or 3 letter country code (case-insensitive)
+ * @returns canonicalized 2 letter country code (uppercase) or undefined if not found
+ */
+export declare function canonicalizeCountryCode(alpha3OrAlpha2?: string): string | undefined;

package/lib/src/countryCodes.js

@@ -1,12 +1,17 @@
-import alpha3CountryCodes from './iso3166Alpha3CountryCodes.json';
+import * as alpha3CountryCodes from './iso3166Alpha3CountryCodes.json';
 var COUNTRY_CODE_ALPHA2 = new Set(Object.keys(alpha3CountryCodes).map(function (key) { return alpha3CountryCodes[key]; }));
-export function countryCodeAlpha3ToAlpha2(alpha3) {
-    if (!alpha3) {
+/**
+ * Canonicalize a country code to a alpha2 country code (uppercase).
+ * @param alpha3OrAlpha2 - 2 or 3 letter country code (case-insensitive)
+ * @returns canonicalized 2 letter country code (uppercase) or undefined if not found
+ */
+export function canonicalizeCountryCode(alpha3OrAlpha2) {
+    if (!alpha3OrAlpha2) {
         return;
     }
-    var upper = alpha3.toUpperCase();
+    var upper = alpha3OrAlpha2.toUpperCase();
     // Lenient here, if it's already a 2 letter code, just return it
-    if (alpha3.length === 2) {
+    if (upper.length === 2) {
         return COUNTRY_CODE_ALPHA2.has(upper) ? upper : undefined;
     }
     return alpha3CountryCodes[upper];

package/lib/src/defaultCurrency.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Look up default currency for a country code.
+ * @param countryCode country code (alpha-2)
+ * @returns default currency code, or USD if not found
+ */
+export declare function defaultCurrency(countryCode?: string): string | undefined;

package/lib/src/defaultCurrency.js

@@ -0,0 +1,11 @@
+import { canonicalizeCountryCode } from './countryCodes';
+import * as data from './defaultCurrencyData.generated.json';
+/**
+ * Look up default currency for a country code.
+ * @param countryCode country code (alpha-2)
+ * @returns default currency code, or USD if not found
+ */
+export function defaultCurrency(countryCode) {
+    countryCode = canonicalizeCountryCode(countryCode);
+    return ((countryCode && countryCode in data && data[countryCode]) || 'USD');
+}

package/lib/src/defaultCurrencyData.generated.json

@@ -0,0 +1 @@
+{ "AC": "SHP", "AD": "EUR", "AE": "AED", "AF": "AFN", "AG": "XCD", "AI": "XCD", "AL": "ALL", "AM": "AMD", "AO": "AOA", "AQ": "XXX", "AR": "ARS", "AS": "USD", "AT": "EUR", "AU": "AUD", "AW": "AWG", "AX": "EUR", "AZ": "AZN", "BA": "BAM", "BB": "BBD", "BD": "BDT", "BE": "EUR", "BF": "XOF", "BG": "BGN", "BH": "BHD", "BI": "BIF", "BJ": "XOF", "BL": "EUR", "BM": "BMD", "BN": "BND", "BO": "BOB", "BQ": "USD", "BR": "BRL", "BS": "BSD", "BT": "BTN", "BU": "BUK", "BV": "NOK", "BW": "BWP", "BY": "BYN", "BZ": "BZD", "CA": "CAD", "CC": "AUD", "CD": "CDF", "CF": "XAF", "CG": "XAF", "CH": "CHF", "CI": "XOF", "CK": "NZD", "CL": "CLP", "CM": "XAF", "CN": "CNH", "CO": "COP", "CP": "XXX", "CR": "CRC", "CS": "EUR", "CU": "CUC", "CV": "CVE", "CW": "ANG", "CX": "AUD", "CY": "EUR", "CZ": "CZK", "DD": "DDM", "DE": "EUR", "DG": "USD", "DJ": "DJF", "DK": "DKK", "DM": "XCD", "DO": "DOP", "DZ": "DZD", "EA": "EUR", "EC": "USD", "EE": "EUR", "EG": "EGP", "EH": "MAD", "ER": "ERN", "ES": "EUR", "ET": "ETB", "EU": "EUR", "FI": "EUR", "FJ": "FJD", "FK": "FKP", "FM": "USD", "FO": "DKK", "FR": "EUR", "GA": "XAF", "GB": "GBP", "GD": "XCD", "GE": "GEL", "GF": "EUR", "GG": "GBP", "GH": "GHS", "GI": "GIP", "GL": "DKK", "GM": "GMD", "GN": "GNF", "GP": "EUR", "GQ": "XAF", "GR": "EUR", "GS": "GBP", "GT": "GTQ", "GU": "USD", "GW": "XOF", "GY": "GYD", "HK": "HKD", "HM": "AUD", "HN": "HNL", "HR": "EUR", "HT": "USD", "HU": "HUF", "IC": "EUR", "ID": "IDR", "IE": "EUR", "IL": "ILS", "IM": "GBP", "IN": "INR", "IO": "USD", "IQ": "IQD", "IR": "IRR", "IS": "ISK", "IT": "EUR", "JE": "GBP", "JM": "JMD", "JO": "JOD", "JP": "JPY", "KE": "KES", "KG": "KGS", "KH": "KHR", "KI": "AUD", "KM": "KMF", "KN": "XCD", "KP": "KPW", "KR": "KRW", "KW": "KWD", "KY": "KYD", "KZ": "KZT", "LA": "LAK", "LB": "LBP", "LC": "XCD", "LI": "CHF", "LK": "LKR", "LR": "LRD", "LS": "LSL", "LT": "EUR", "LU": "EUR", "LV": "EUR", "LY": "LYD", "MA": "MAD", "MC": "EUR", "MD": "MDL", "ME": "EUR", "MF": "EUR", "MG": "MGA", "MH": "USD", "MK": "MKD", "ML": "XOF", "MM": "MMK", "MN": "MNT", "MO": "MOP", "MP": "USD", "MQ": "EUR", "MR": "MRU", "MS": "XCD", "MT": "EUR", "MU": "MUR", "MV": "MVR", "MW": "MWK", "MX": "MXN", "MY": "MYR", "MZ": "MZN", "NA": "NAD", "NC": "XPF", "NE": "XOF", "NF": "AUD", "NG": "NGN", "NI": "NIO", "NL": "EUR", "NO": "NOK", "NP": "NPR", "NR": "AUD", "NU": "NZD", "NZ": "NZD", "OM": "OMR", "PA": "USD", "PE": "PEN", "PF": "XPF", "PG": "PGK", "PH": "PHP", "PK": "PKR", "PL": "PLN", "PM": "EUR", "PN": "NZD", "PR": "USD", "PS": "JOD", "PT": "EUR", "PW": "USD", "PY": "PYG", "QA": "QAR", "RE": "EUR", "RO": "RON", "RS": "RSD", "RU": "RUB", "RW": "RWF", "SA": "SAR", "SB": "SBD", "SC": "SCR", "SD": "SDG", "SE": "SEK", "SG": "SGD", "SH": "SHP", "SI": "EUR", "SJ": "NOK", "SK": "EUR", "SL": "SLE", "SM": "EUR", "SN": "XOF", "SO": "SOS", "SR": "SRD", "SS": "SSP", "ST": "STN", "SU": "SUR", "SV": "USD", "SX": "ANG", "SY": "SYP", "SZ": "SZL", "TA": "GBP", "TC": "USD", "TD": "XAF", "TF": "EUR", "TG": "XOF", "TH": "THB", "TJ": "TJS", "TK": "NZD", "TL": "USD", "TM": "TMT", "TN": "TND", "TO": "TOP", "TP": "IDR", "TR": "TRY", "TT": "TTD", "TV": "AUD", "TW": "TWD", "TZ": "TZS", "UA": "UAH", "UG": "UGX", "UM": "USD", "US": "USD", "UY": "UYU", "UZ": "UZS", "VA": "EUR", "VC": "XCD", "VE": "VES", "VG": "GBP", "VI": "USD", "VN": "VND", "VU": "VUV", "WF": "XPF", "WS": "WST", "XK": "EUR", "YD": "YDD", "YE": "YER", "YT": "EUR", "YU": "YUM", "ZA": "ZAL", "ZM": "ZMW", "ZR": "ZRN", "ZW": "USD", "ZZ": "XFO" }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formatjs/utils",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Collection of useful intl utilities",
   "main": "index.js",
   "module": "lib/index.js",

package/src/countryCodes.d.ts

@@ -1 +1,6 @@
-export declare function countryCodeAlpha3ToAlpha2(alpha3?: string): string | undefined;
+/**
+ * Canonicalize a country code to a alpha2 country code (uppercase).
+ * @param alpha3OrAlpha2 - 2 or 3 letter country code (case-insensitive)
+ * @returns canonicalized 2 letter country code (uppercase) or undefined if not found
+ */
+export declare function canonicalizeCountryCode(alpha3OrAlpha2?: string): string | undefined;

package/src/countryCodes.js

@@ -1,18 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.countryCodeAlpha3ToAlpha2 = void 0;
+exports.canonicalizeCountryCode = void 0;
 var tslib_1 = require("tslib");
-var iso3166Alpha3CountryCodes_json_1 = tslib_1.__importDefault(require("./iso3166Alpha3CountryCodes.json"));
-var COUNTRY_CODE_ALPHA2 = new Set(Object.keys(iso3166Alpha3CountryCodes_json_1.default).map(function (key) { return iso3166Alpha3CountryCodes_json_1.default[key]; }));
-function countryCodeAlpha3ToAlpha2(alpha3) {
-    if (!alpha3) {
+var alpha3CountryCodes = tslib_1.__importStar(require("./iso3166Alpha3CountryCodes.json"));
+var COUNTRY_CODE_ALPHA2 = new Set(Object.keys(alpha3CountryCodes).map(function (key) { return alpha3CountryCodes[key]; }));
+/**
+ * Canonicalize a country code to a alpha2 country code (uppercase).
+ * @param alpha3OrAlpha2 - 2 or 3 letter country code (case-insensitive)
+ * @returns canonicalized 2 letter country code (uppercase) or undefined if not found
+ */
+function canonicalizeCountryCode(alpha3OrAlpha2) {
+    if (!alpha3OrAlpha2) {
         return;
     }
-    var upper = alpha3.toUpperCase();
+    var upper = alpha3OrAlpha2.toUpperCase();
     // Lenient here, if it's already a 2 letter code, just return it
-    if (alpha3.length === 2) {
+    if (upper.length === 2) {
         return COUNTRY_CODE_ALPHA2.has(upper) ? upper : undefined;
     }
-    return iso3166Alpha3CountryCodes_json_1.default[upper];
+    return alpha3CountryCodes[upper];
 }
-exports.countryCodeAlpha3ToAlpha2 = countryCodeAlpha3ToAlpha2;
+exports.canonicalizeCountryCode = canonicalizeCountryCode;

package/src/defaultCurrency.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Look up default currency for a country code.
+ * @param countryCode country code (alpha-2)
+ * @returns default currency code, or USD if not found
+ */
+export declare function defaultCurrency(countryCode?: string): string | undefined;

package/src/defaultCurrency.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultCurrency = void 0;
+var tslib_1 = require("tslib");
+var countryCodes_1 = require("./countryCodes");
+var data = tslib_1.__importStar(require("./defaultCurrencyData.generated.json"));
+/**
+ * Look up default currency for a country code.
+ * @param countryCode country code (alpha-2)
+ * @returns default currency code, or USD if not found
+ */
+function defaultCurrency(countryCode) {
+    countryCode = (0, countryCodes_1.canonicalizeCountryCode)(countryCode);
+    return ((countryCode && countryCode in data && data[countryCode]) || 'USD');
+}
+exports.defaultCurrency = defaultCurrency;

package/src/defaultCurrencyData.generated.json

@@ -0,0 +1 @@
+{"AC":"SHP","AD":"EUR","AE":"AED","AF":"AFN","AG":"XCD","AI":"XCD","AL":"ALL","AM":"AMD","AO":"AOA","AQ":"XXX","AR":"ARS","AS":"USD","AT":"EUR","AU":"AUD","AW":"AWG","AX":"EUR","AZ":"AZN","BA":"BAM","BB":"BBD","BD":"BDT","BE":"EUR","BF":"XOF","BG":"BGN","BH":"BHD","BI":"BIF","BJ":"XOF","BL":"EUR","BM":"BMD","BN":"BND","BO":"BOB","BQ":"USD","BR":"BRL","BS":"BSD","BT":"BTN","BU":"BUK","BV":"NOK","BW":"BWP","BY":"BYN","BZ":"BZD","CA":"CAD","CC":"AUD","CD":"CDF","CF":"XAF","CG":"XAF","CH":"CHF","CI":"XOF","CK":"NZD","CL":"CLP","CM":"XAF","CN":"CNH","CO":"COP","CP":"XXX","CR":"CRC","CS":"EUR","CU":"CUC","CV":"CVE","CW":"ANG","CX":"AUD","CY":"EUR","CZ":"CZK","DD":"DDM","DE":"EUR","DG":"USD","DJ":"DJF","DK":"DKK","DM":"XCD","DO":"DOP","DZ":"DZD","EA":"EUR","EC":"USD","EE":"EUR","EG":"EGP","EH":"MAD","ER":"ERN","ES":"EUR","ET":"ETB","EU":"EUR","FI":"EUR","FJ":"FJD","FK":"FKP","FM":"USD","FO":"DKK","FR":"EUR","GA":"XAF","GB":"GBP","GD":"XCD","GE":"GEL","GF":"EUR","GG":"GBP","GH":"GHS","GI":"GIP","GL":"DKK","GM":"GMD","GN":"GNF","GP":"EUR","GQ":"XAF","GR":"EUR","GS":"GBP","GT":"GTQ","GU":"USD","GW":"XOF","GY":"GYD","HK":"HKD","HM":"AUD","HN":"HNL","HR":"EUR","HT":"USD","HU":"HUF","IC":"EUR","ID":"IDR","IE":"EUR","IL":"ILS","IM":"GBP","IN":"INR","IO":"USD","IQ":"IQD","IR":"IRR","IS":"ISK","IT":"EUR","JE":"GBP","JM":"JMD","JO":"JOD","JP":"JPY","KE":"KES","KG":"KGS","KH":"KHR","KI":"AUD","KM":"KMF","KN":"XCD","KP":"KPW","KR":"KRW","KW":"KWD","KY":"KYD","KZ":"KZT","LA":"LAK","LB":"LBP","LC":"XCD","LI":"CHF","LK":"LKR","LR":"LRD","LS":"LSL","LT":"EUR","LU":"EUR","LV":"EUR","LY":"LYD","MA":"MAD","MC":"EUR","MD":"MDL","ME":"EUR","MF":"EUR","MG":"MGA","MH":"USD","MK":"MKD","ML":"XOF","MM":"MMK","MN":"MNT","MO":"MOP","MP":"USD","MQ":"EUR","MR":"MRU","MS":"XCD","MT":"EUR","MU":"MUR","MV":"MVR","MW":"MWK","MX":"MXN","MY":"MYR","MZ":"MZN","NA":"NAD","NC":"XPF","NE":"XOF","NF":"AUD","NG":"NGN","NI":"NIO","NL":"EUR","NO":"NOK","NP":"NPR","NR":"AUD","NU":"NZD","NZ":"NZD","OM":"OMR","PA":"USD","PE":"PEN","PF":"XPF","PG":"PGK","PH":"PHP","PK":"PKR","PL":"PLN","PM":"EUR","PN":"NZD","PR":"USD","PS":"JOD","PT":"EUR","PW":"USD","PY":"PYG","QA":"QAR","RE":"EUR","RO":"RON","RS":"RSD","RU":"RUB","RW":"RWF","SA":"SAR","SB":"SBD","SC":"SCR","SD":"SDG","SE":"SEK","SG":"SGD","SH":"SHP","SI":"EUR","SJ":"NOK","SK":"EUR","SL":"SLE","SM":"EUR","SN":"XOF","SO":"SOS","SR":"SRD","SS":"SSP","ST":"STN","SU":"SUR","SV":"USD","SX":"ANG","SY":"SYP","SZ":"SZL","TA":"GBP","TC":"USD","TD":"XAF","TF":"EUR","TG":"XOF","TH":"THB","TJ":"TJS","TK":"NZD","TL":"USD","TM":"TMT","TN":"TND","TO":"TOP","TP":"IDR","TR":"TRY","TT":"TTD","TV":"AUD","TW":"TWD","TZ":"TZS","UA":"UAH","UG":"UGX","UM":"USD","US":"USD","UY":"UYU","UZ":"UZS","VA":"EUR","VC":"XCD","VE":"VES","VG":"GBP","VI":"USD","VN":"VND","VU":"VUV","WF":"XPF","WS":"WST","XK":"EUR","YD":"YDD","YE":"YER","YT":"EUR","YU":"YUM","ZA":"ZAL","ZM":"ZMW","ZR":"ZRN","ZW":"USD","ZZ":"XFO"}