@formatjs/utils 2.0.2 → 2.0.4

package/README.md

@@ -1,3 +1,99 @@
 # @formatjs/utils
 
-This is a collection of generally intl-related utilities that are useful.
+Collection of useful internationalization (i18n) utilities for working with locales, countries, currencies, and timezones.
+
+## Installation
+
+```bash
+npm install @formatjs/utils
+```
+
+## Features
+
+- Country code canonicalization (ISO 3166)
+- Default currency lookup by country
+- Currency minor units and scale calculations (ISO 4217)
+- Default locale detection
+- Default timezone detection
+
+## API
+
+### Country Codes
+
+#### `canonicalizeCountryCode(alpha3OrAlpha2?: string): string | undefined`
+
+Canonicalize a country code to an ISO 3166 alpha-2 country code (uppercase).
+
+```typescript
+import {canonicalizeCountryCode} from '@formatjs/utils'
+
+canonicalizeCountryCode('usa') // 'US'
+canonicalizeCountryCode('USA') // 'US'
+canonicalizeCountryCode('us') // 'US'
+canonicalizeCountryCode('US') // 'US'
+```
+
+### Currency
+
+#### `defaultCurrency(countryCode?: string): string`
+
+Look up the default currency for a country code. Returns USD if not found.
+
+```typescript
+import {defaultCurrency} from '@formatjs/utils'
+
+defaultCurrency('US') // 'USD'
+defaultCurrency('GB') // 'GBP'
+defaultCurrency('JP') // 'JPY'
+```
+
+#### `countriesUsingDefaultCurrency(currencyCode: string): string[]`
+
+Look up countries that use a specific currency as their default.
+
+```typescript
+import {countriesUsingDefaultCurrency} from '@formatjs/utils'
+
+countriesUsingDefaultCurrency('EUR') // ['AT', 'BE', 'CY', 'DE', 'EE', ...]
+countriesUsingDefaultCurrency('USD') // ['US', 'EC', 'SV', ...]
+```
+
+#### `currencyMinorScale(currencyCode: string): number`
+
+Returns the minor unit scale for a given ISO 4217 currency code. The minor unit scale is the power of 10 representing the number of decimal places used for the currency.
+
+```typescript
+import {currencyMinorScale} from '@formatjs/utils'
+
+currencyMinorScale('USD') // 100 (2 decimal places)
+currencyMinorScale('JPY') // 1 (0 decimal places)
+currencyMinorScale('BHD') // 1000 (3 decimal places)
+```
+
+### Locale
+
+#### `defaultLocale(): string`
+
+Returns the default locale for the current environment.
+
+```typescript
+import {defaultLocale} from '@formatjs/utils'
+
+defaultLocale() // e.g., 'en-US'
+```
+
+### Timezone
+
+#### `defaultTimezone(): string`
+
+Returns the default timezone for the current environment.
+
+```typescript
+import {defaultTimezone} from '@formatjs/utils'
+
+defaultTimezone() // e.g., 'America/New_York'
+```
+
+## License
+
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formatjs/utils",
   "description": "Collection of useful intl utilities",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "license": "MIT",
   "author": "Long Ho <holevietlong@gmail.com>",
   "type": "module",

package/src/countryCodes.js

@@ -1,4 +1,4 @@
-import * as alpha3CountryCodes from './iso3166Alpha3CountryCodes.json';
+import alpha3CountryCodes from './iso3166Alpha3CountryCodes.js';
 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).

package/src/currencyMinorUnits.generated.d.ts

@@ -0,0 +1,169 @@
+declare const _default: {
+    readonly AFN: 2;
+    readonly EUR: 2;
+    readonly ALL: 2;
+    readonly DZD: 2;
+    readonly USD: 2;
+    readonly AOA: 2;
+    readonly XCD: 2;
+    readonly XAD: 2;
+    readonly ARS: 2;
+    readonly AMD: 2;
+    readonly AWG: 2;
+    readonly AUD: 2;
+    readonly AZN: 2;
+    readonly BSD: 2;
+    readonly BHD: 3;
+    readonly BDT: 2;
+    readonly BBD: 2;
+    readonly BYN: 2;
+    readonly BZD: 2;
+    readonly XOF: 0;
+    readonly BMD: 2;
+    readonly INR: 2;
+    readonly BTN: 2;
+    readonly BOB: 2;
+    readonly BOV: 2;
+    readonly BAM: 2;
+    readonly BWP: 2;
+    readonly NOK: 2;
+    readonly BRL: 2;
+    readonly BND: 2;
+    readonly BGN: 2;
+    readonly BIF: 0;
+    readonly CVE: 2;
+    readonly KHR: 2;
+    readonly XAF: 0;
+    readonly CAD: 2;
+    readonly KYD: 2;
+    readonly CLP: 0;
+    readonly CLF: 4;
+    readonly CNY: 2;
+    readonly COP: 2;
+    readonly COU: 2;
+    readonly KMF: 0;
+    readonly CDF: 2;
+    readonly NZD: 2;
+    readonly CRC: 2;
+    readonly CUP: 2;
+    readonly XCG: 2;
+    readonly CZK: 2;
+    readonly DKK: 2;
+    readonly DJF: 0;
+    readonly DOP: 2;
+    readonly EGP: 2;
+    readonly SVC: 2;
+    readonly ERN: 2;
+    readonly SZL: 2;
+    readonly ETB: 2;
+    readonly FKP: 2;
+    readonly FJD: 2;
+    readonly XPF: 0;
+    readonly GMD: 2;
+    readonly GEL: 2;
+    readonly GHS: 2;
+    readonly GIP: 2;
+    readonly GTQ: 2;
+    readonly GBP: 2;
+    readonly GNF: 0;
+    readonly GYD: 2;
+    readonly HTG: 2;
+    readonly HNL: 2;
+    readonly HKD: 2;
+    readonly HUF: 2;
+    readonly ISK: 0;
+    readonly IDR: 2;
+    readonly IRR: 2;
+    readonly IQD: 3;
+    readonly ILS: 2;
+    readonly JMD: 2;
+    readonly JPY: 0;
+    readonly JOD: 3;
+    readonly KZT: 2;
+    readonly KES: 2;
+    readonly KPW: 2;
+    readonly KRW: 0;
+    readonly KWD: 3;
+    readonly KGS: 2;
+    readonly LAK: 2;
+    readonly LBP: 2;
+    readonly LSL: 2;
+    readonly ZAR: 2;
+    readonly LRD: 2;
+    readonly LYD: 3;
+    readonly CHF: 2;
+    readonly MOP: 2;
+    readonly MKD: 2;
+    readonly MGA: 2;
+    readonly MWK: 2;
+    readonly MYR: 2;
+    readonly MVR: 2;
+    readonly MRU: 2;
+    readonly MUR: 2;
+    readonly MXN: 2;
+    readonly MXV: 2;
+    readonly MDL: 2;
+    readonly MNT: 2;
+    readonly MAD: 2;
+    readonly MZN: 2;
+    readonly MMK: 2;
+    readonly NAD: 2;
+    readonly NPR: 2;
+    readonly NIO: 2;
+    readonly NGN: 2;
+    readonly OMR: 3;
+    readonly PKR: 2;
+    readonly PAB: 2;
+    readonly PGK: 2;
+    readonly PYG: 0;
+    readonly PEN: 2;
+    readonly PHP: 2;
+    readonly PLN: 2;
+    readonly QAR: 2;
+    readonly RON: 2;
+    readonly RUB: 2;
+    readonly RWF: 0;
+    readonly SHP: 2;
+    readonly WST: 2;
+    readonly STN: 2;
+    readonly SAR: 2;
+    readonly RSD: 2;
+    readonly SCR: 2;
+    readonly SLE: 2;
+    readonly SGD: 2;
+    readonly SBD: 2;
+    readonly SOS: 2;
+    readonly SSP: 2;
+    readonly LKR: 2;
+    readonly SDG: 2;
+    readonly SRD: 2;
+    readonly SEK: 2;
+    readonly CHE: 2;
+    readonly CHW: 2;
+    readonly SYP: 2;
+    readonly TWD: 2;
+    readonly TJS: 2;
+    readonly TZS: 2;
+    readonly THB: 2;
+    readonly TOP: 2;
+    readonly TTD: 2;
+    readonly TND: 3;
+    readonly TRY: 2;
+    readonly TMT: 2;
+    readonly UGX: 0;
+    readonly UAH: 2;
+    readonly AED: 2;
+    readonly USN: 2;
+    readonly UYU: 2;
+    readonly UYI: 0;
+    readonly UYW: 4;
+    readonly UZS: 2;
+    readonly VUV: 0;
+    readonly VES: 2;
+    readonly VED: 2;
+    readonly VND: 0;
+    readonly YER: 2;
+    readonly ZMW: 2;
+    readonly ZWG: 2;
+};
+export default _default;

package/src/currencyMinorUnits.generated.js

@@ -0,0 +1,169 @@
+// This is a generated file. Do not edit directly.
+export default {
+    "AFN": 2,
+    "EUR": 2,
+    "ALL": 2,
+    "DZD": 2,
+    "USD": 2,
+    "AOA": 2,
+    "XCD": 2,
+    "XAD": 2,
+    "ARS": 2,
+    "AMD": 2,
+    "AWG": 2,
+    "AUD": 2,
+    "AZN": 2,
+    "BSD": 2,
+    "BHD": 3,
+    "BDT": 2,
+    "BBD": 2,
+    "BYN": 2,
+    "BZD": 2,
+    "XOF": 0,
+    "BMD": 2,
+    "INR": 2,
+    "BTN": 2,
+    "BOB": 2,
+    "BOV": 2,
+    "BAM": 2,
+    "BWP": 2,
+    "NOK": 2,
+    "BRL": 2,
+    "BND": 2,
+    "BGN": 2,
+    "BIF": 0,
+    "CVE": 2,
+    "KHR": 2,
+    "XAF": 0,
+    "CAD": 2,
+    "KYD": 2,
+    "CLP": 0,
+    "CLF": 4,
+    "CNY": 2,
+    "COP": 2,
+    "COU": 2,
+    "KMF": 0,
+    "CDF": 2,
+    "NZD": 2,
+    "CRC": 2,
+    "CUP": 2,
+    "XCG": 2,
+    "CZK": 2,
+    "DKK": 2,
+    "DJF": 0,
+    "DOP": 2,
+    "EGP": 2,
+    "SVC": 2,
+    "ERN": 2,
+    "SZL": 2,
+    "ETB": 2,
+    "FKP": 2,
+    "FJD": 2,
+    "XPF": 0,
+    "GMD": 2,
+    "GEL": 2,
+    "GHS": 2,
+    "GIP": 2,
+    "GTQ": 2,
+    "GBP": 2,
+    "GNF": 0,
+    "GYD": 2,
+    "HTG": 2,
+    "HNL": 2,
+    "HKD": 2,
+    "HUF": 2,
+    "ISK": 0,
+    "IDR": 2,
+    "IRR": 2,
+    "IQD": 3,
+    "ILS": 2,
+    "JMD": 2,
+    "JPY": 0,
+    "JOD": 3,
+    "KZT": 2,
+    "KES": 2,
+    "KPW": 2,
+    "KRW": 0,
+    "KWD": 3,
+    "KGS": 2,
+    "LAK": 2,
+    "LBP": 2,
+    "LSL": 2,
+    "ZAR": 2,
+    "LRD": 2,
+    "LYD": 3,
+    "CHF": 2,
+    "MOP": 2,
+    "MKD": 2,
+    "MGA": 2,
+    "MWK": 2,
+    "MYR": 2,
+    "MVR": 2,
+    "MRU": 2,
+    "MUR": 2,
+    "MXN": 2,
+    "MXV": 2,
+    "MDL": 2,
+    "MNT": 2,
+    "MAD": 2,
+    "MZN": 2,
+    "MMK": 2,
+    "NAD": 2,
+    "NPR": 2,
+    "NIO": 2,
+    "NGN": 2,
+    "OMR": 3,
+    "PKR": 2,
+    "PAB": 2,
+    "PGK": 2,
+    "PYG": 0,
+    "PEN": 2,
+    "PHP": 2,
+    "PLN": 2,
+    "QAR": 2,
+    "RON": 2,
+    "RUB": 2,
+    "RWF": 0,
+    "SHP": 2,
+    "WST": 2,
+    "STN": 2,
+    "SAR": 2,
+    "RSD": 2,
+    "SCR": 2,
+    "SLE": 2,
+    "SGD": 2,
+    "SBD": 2,
+    "SOS": 2,
+    "SSP": 2,
+    "LKR": 2,
+    "SDG": 2,
+    "SRD": 2,
+    "SEK": 2,
+    "CHE": 2,
+    "CHW": 2,
+    "SYP": 2,
+    "TWD": 2,
+    "TJS": 2,
+    "TZS": 2,
+    "THB": 2,
+    "TOP": 2,
+    "TTD": 2,
+    "TND": 3,
+    "TRY": 2,
+    "TMT": 2,
+    "UGX": 0,
+    "UAH": 2,
+    "AED": 2,
+    "USN": 2,
+    "UYU": 2,
+    "UYI": 0,
+    "UYW": 4,
+    "UZS": 2,
+    "VUV": 0,
+    "VES": 2,
+    "VED": 2,
+    "VND": 0,
+    "YER": 2,
+    "ZMW": 2,
+    "ZWG": 2
+};

package/src/defaultCurrency.js

@@ -1,5 +1,5 @@
 import { canonicalizeCountryCode } from './countryCodes.js';
-import * as data from './defaultCurrencyData.generated.json';
+import data from './defaultCurrencyData.generated.js';
 var COUNTRIES_BY_DEFAULT_CURRENCY = Object.keys(data).reduce(function (acc, countryCode) {
     var currencyCode = data[countryCode];
     if (!acc[currencyCode]) {