country-codes-library 1.1.3 → 2.0.0

package/dist/countryNames.js

@@ -0,0 +1,252 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CountryNames = void 0;
+/**
+ * Mapping of PascalCase keys to proper country names
+ * This provides the canonical display names for all countries
+ */
+exports.CountryNames = {
+    Afghanistan: "Afghanistan",
+    AlandIslands: "Åland Islands",
+    Albania: "Albania",
+    Algeria: "Algeria",
+    AmericanSamoa: "American Samoa",
+    Andorra: "Andorra",
+    Angola: "Angola",
+    Anguilla: "Anguilla",
+    AntiguaandBarbuda: "Antigua and Barbuda",
+    Argentina: "Argentina",
+    Armenia: "Armenia",
+    Aruba: "Aruba",
+    Australia: "Australia",
+    Austria: "Austria",
+    Azerbaijan: "Azerbaijan",
+    Bahamas: "Bahamas",
+    Bahrain: "Bahrain",
+    Bangladesh: "Bangladesh",
+    Barbados: "Barbados",
+    Belarus: "Belarus",
+    Belgium: "Belgium",
+    Belize: "Belize",
+    Benin: "Benin",
+    Bermuda: "Bermuda",
+    Bhutan: "Bhutan",
+    Bolivia: "Bolivia",
+    BonaireSintEustatiusandSaba: "Bonaire, Sint Eustatius and Saba",
+    BosniaandHerzegovina: "Bosnia and Herzegovina",
+    Botswana: "Botswana",
+    Brazil: "Brazil",
+    BritishIndianOceanTerritory: "British Indian Ocean Territory",
+    BritishVirginIslands: "British Virgin Islands",
+    Brunei: "Brunei",
+    Bulgaria: "Bulgaria",
+    BurkinaFaso: "Burkina Faso",
+    Burundi: "Burundi",
+    CaboVerde: "Cabo Verde",
+    Cambodia: "Cambodia",
+    Cameroon: "Cameroon",
+    Canada: "Canada",
+    CaymanIslands: "Cayman Islands",
+    CentralAfricanRepublic: "Central African Republic",
+    Chad: "Chad",
+    Chile: "Chile",
+    China: "China",
+    ChristmasIsland: "Christmas Island",
+    Cocos_Keeling_Islands: "Cocos (Keeling) Islands",
+    Colombia: "Colombia",
+    Comoros: "Comoros",
+    Congo: "Congo",
+    Congo_DRC: "Congo (DRC)",
+    CookIslands: "Cook Islands",
+    CostaRica: "Costa Rica",
+    CotedIvoire: "Côte d'Ivoire",
+    Croatia: "Croatia",
+    Cuba: "Cuba",
+    Curacao: "Curaçao",
+    Cyprus: "Cyprus",
+    Czechia: "Czechia",
+    Denmark: "Denmark",
+    Djibouti: "Djibouti",
+    Dominica: "Dominica",
+    DominicanRepublic: "Dominican Republic",
+    Ecuador: "Ecuador",
+    Egypt: "Egypt",
+    ElSalvador: "El Salvador",
+    EquatorialGuinea: "Equatorial Guinea",
+    Eritrea: "Eritrea",
+    Estonia: "Estonia",
+    Eswatini: "Eswatini",
+    Ethiopia: "Ethiopia",
+    FalklandIslands: "Falkland Islands",
+    FaroeIslands: "Faroe Islands",
+    Fiji: "Fiji",
+    Finland: "Finland",
+    France: "France",
+    FrenchGuiana: "French Guiana",
+    FrenchPolynesia: "French Polynesia",
+    Gabon: "Gabon",
+    Gambia: "Gambia",
+    Georgia: "Georgia",
+    Germany: "Germany",
+    Ghana: "Ghana",
+    Gibraltar: "Gibraltar",
+    Greece: "Greece",
+    Greenland: "Greenland",
+    Grenada: "Grenada",
+    Guadeloupe: "Guadeloupe",
+    Guam: "Guam",
+    Guatemala: "Guatemala",
+    Guernsey: "Guernsey",
+    Guinea: "Guinea",
+    GuineaBissau: "Guinea-Bissau",
+    Guyana: "Guyana",
+    Haiti: "Haiti",
+    Honduras: "Honduras",
+    HongKongSAR: "Hong Kong SAR",
+    Hungary: "Hungary",
+    Iceland: "Iceland",
+    India: "India",
+    Indonesia: "Indonesia",
+    Iran: "Iran",
+    Iraq: "Iraq",
+    Ireland: "Ireland",
+    IsleofMan: "Isle of Man",
+    Israel: "Israel",
+    Italy: "Italy",
+    Jamaica: "Jamaica",
+    Japan: "Japan",
+    Jersey: "Jersey",
+    Jordan: "Jordan",
+    Kazakhstan: "Kazakhstan",
+    Kenya: "Kenya",
+    Kiribati: "Kiribati",
+    Korea: "Korea",
+    Kuwait: "Kuwait",
+    Kyrgyzstan: "Kyrgyzstan",
+    Laos: "Laos",
+    Latvia: "Latvia",
+    Lebanon: "Lebanon",
+    Lesotho: "Lesotho",
+    Liberia: "Liberia",
+    Libya: "Libya",
+    Liechtenstein: "Liechtenstein",
+    Lithuania: "Lithuania",
+    Luxembourg: "Luxembourg",
+    MacaoSAR: "Macao SAR",
+    Madagascar: "Madagascar",
+    Malawi: "Malawi",
+    Malaysia: "Malaysia",
+    Maldives: "Maldives",
+    Mali: "Mali",
+    Malta: "Malta",
+    MarshallIslands: "Marshall Islands",
+    Martinique: "Martinique",
+    Mauritania: "Mauritania",
+    Mauritius: "Mauritius",
+    Mayotte: "Mayotte",
+    Mexico: "Mexico",
+    Micronesia: "Micronesia",
+    Moldova: "Moldova",
+    Monaco: "Monaco",
+    Mongolia: "Mongolia",
+    Montenegro: "Montenegro",
+    Montserrat: "Montserrat",
+    Morocco: "Morocco",
+    Mozambique: "Mozambique",
+    Myanmar: "Myanmar",
+    Namibia: "Namibia",
+    Nauru: "Nauru",
+    Nepal: "Nepal",
+    Netherlands: "Netherlands",
+    NewCaledonia: "New Caledonia",
+    NewZealand: "New Zealand",
+    Nicaragua: "Nicaragua",
+    Niger: "Niger",
+    Nigeria: "Nigeria",
+    Niue: "Niue",
+    NorfolkIsland: "Norfolk Island",
+    NorthKorea: "North Korea",
+    NorthMacedonia: "North Macedonia",
+    NorthernMarianaIslands: "Northern Mariana Islands",
+    Norway: "Norway",
+    Oman: "Oman",
+    Pakistan: "Pakistan",
+    Palau: "Palau",
+    PalestinianAuthority: "Palestinian Authority",
+    Panama: "Panama",
+    PapuaNewGuinea: "Papua New Guinea",
+    Paraguay: "Paraguay",
+    Peru: "Peru",
+    Philippines: "Philippines",
+    PitcairnIslands: "Pitcairn Islands",
+    Poland: "Poland",
+    Portugal: "Portugal",
+    PuertoRico: "Puerto Rico",
+    Qatar: "Qatar",
+    Reunion: "Réunion",
+    Romania: "Romania",
+    Russia: "Russia",
+    Rwanda: "Rwanda",
+    Samoa: "Samoa",
+    SanMarino: "San Marino",
+    SaoTomeandPrincipe: "São Tomé and Príncipe",
+    SaudiArabia: "Saudi Arabia",
+    Senegal: "Senegal",
+    Serbia: "Serbia",
+    Seychelles: "Seychelles",
+    SierraLeone: "Sierra Leone",
+    Singapore: "Singapore",
+    SintMaarten: "Sint Maarten",
+    Slovakia: "Slovakia",
+    Slovenia: "Slovenia",
+    SolomonIslands: "Solomon Islands",
+    Somalia: "Somalia",
+    SouthAfrica: "South Africa",
+    SouthSudan: "South Sudan",
+    Spain: "Spain",
+    SriLanka: "Sri Lanka",
+    StHelenaAscensionTristandaCunha: "St. Helena, Ascension, Tristan da Cunha",
+    StBarthelemy: "St. Barthélemy",
+    StKittsandNevis: "St. Kitts and Nevis",
+    StLucia: "St. Lucia",
+    StMartin: "St. Martin",
+    StPierreandMiquelon: "St. Pierre and Miquelon",
+    StVincentandtheGrenadines: "St. Vincent and the Grenadines",
+    Sudan: "Sudan",
+    Suriname: "Suriname",
+    SvalbardandJanMayen: "Svalbard and Jan Mayen",
+    Sweden: "Sweden",
+    Switzerland: "Switzerland",
+    Syria: "Syria",
+    Taiwan: "Taiwan",
+    Tajikistan: "Tajikistan",
+    Tanzania: "Tanzania",
+    Thailand: "Thailand",
+    TimorLeste: "Timor-Leste",
+    Togo: "Togo",
+    Tokelau: "Tokelau",
+    Tonga: "Tonga",
+    TrinidadandTobago: "Trinidad and Tobago",
+    Tunisia: "Tunisia",
+    Turkey: "Turkey",
+    Turkmenistan: "Turkmenistan",
+    TurksandCaicosIslands: "Turks and Caicos Islands",
+    Tuvalu: "Tuvalu",
+    USOutlyingIslands: "U.S. Outlying Islands",
+    USVirginIslands: "U.S. Virgin Islands",
+    Uganda: "Uganda",
+    Ukraine: "Ukraine",
+    UnitedArabEmirates: "United Arab Emirates",
+    UnitedKingdom: "United Kingdom",
+    UnitedStates: "United States",
+    Uruguay: "Uruguay",
+    Uzbekistan: "Uzbekistan",
+    Vanuatu: "Vanuatu",
+    VaticanCity: "Vatican City",
+    Venezuela: "Venezuela",
+    Vietnam: "Vietnam",
+    WallisandFutuna: "Wallis and Futuna",
+    Yemen: "Yemen",
+    Zambia: "Zambia",
+    Zimbabwe: "Zimbabwe"
+};

package/dist/index.d.ts

@@ -6,3 +6,8 @@ export { CountryCurrencyCodes } from './countryCurrencyCodes';
 export { ChinaProvinceCode } from './China/chinaProvinceCode';
 export { CanadaProvinceCode } from './Canada/canadaProvinceCode';
 export { USAStateCode } from './UnitedStates/USAStateCode';
+export { CountryData, getAllCountries, getAllCountryNames } from './countryData';
+export { CountryNames } from './countryNames';
+export type { Country, LookupResult, SearchOptions, PhoneValidationResult, CountryName, CountryCode2, CountryCode3 } from './types';
+export { getCountryByCode2, getCountryByCode3, getCountryByName, getCountriesByCurrency, getCountriesByCallingCode, searchCountries, convertCountryCode, getCallingCode, getCurrencyCode, getCurrencySymbol, getAllCurrencies, getAllCallingCodes } from './utils';
+export { isValidCountryCode2, isValidCountryCode3, isValidCountryCode, isValidCountryName, isValidCurrencyCode, isValidCallingCode, validatePhoneNumber, parsePhoneNumber } from './validators';

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.USAStateCode = exports.CanadaProvinceCode = exports.ChinaProvinceCode = exports.CountryCurrencyCodes = exports.CountryCurrencySymbols = exports.CountryCallingCodes = exports.ThreeLetterISORegionCode = exports.TwoLetterISORegionCode = void 0;
+exports.parsePhoneNumber = exports.validatePhoneNumber = exports.isValidCallingCode = exports.isValidCurrencyCode = exports.isValidCountryName = exports.isValidCountryCode = exports.isValidCountryCode3 = exports.isValidCountryCode2 = exports.getAllCallingCodes = exports.getAllCurrencies = exports.getCurrencySymbol = exports.getCurrencyCode = exports.getCallingCode = exports.convertCountryCode = exports.searchCountries = exports.getCountriesByCallingCode = exports.getCountriesByCurrency = exports.getCountryByName = exports.getCountryByCode3 = exports.getCountryByCode2 = exports.CountryNames = exports.getAllCountryNames = exports.getAllCountries = exports.CountryData = exports.USAStateCode = exports.CanadaProvinceCode = exports.ChinaProvinceCode = exports.CountryCurrencyCodes = exports.CountryCurrencySymbols = exports.CountryCallingCodes = exports.ThreeLetterISORegionCode = exports.TwoLetterISORegionCode = void 0;
+// Original exports - backwards compatible
 var twoLetterISORegionCode_1 = require("./twoLetterISORegionCode");
 Object.defineProperty(exports, "TwoLetterISORegionCode", { enumerable: true, get: function () { return twoLetterISORegionCode_1.TwoLetterISORegionCode; } });
 var threeLetterISORegionCode_1 = require("./threeLetterISORegionCode");
@@ -17,3 +18,34 @@ var canadaProvinceCode_1 = require("./Canada/canadaProvinceCode");
 Object.defineProperty(exports, "CanadaProvinceCode", { enumerable: true, get: function () { return canadaProvinceCode_1.CanadaProvinceCode; } });
 var USAStateCode_1 = require("./UnitedStates/USAStateCode");
 Object.defineProperty(exports, "USAStateCode", { enumerable: true, get: function () { return USAStateCode_1.USAStateCode; } });
+// New unified country data
+var countryData_1 = require("./countryData");
+Object.defineProperty(exports, "CountryData", { enumerable: true, get: function () { return countryData_1.CountryData; } });
+Object.defineProperty(exports, "getAllCountries", { enumerable: true, get: function () { return countryData_1.getAllCountries; } });
+Object.defineProperty(exports, "getAllCountryNames", { enumerable: true, get: function () { return countryData_1.getAllCountryNames; } });
+var countryNames_1 = require("./countryNames");
+Object.defineProperty(exports, "CountryNames", { enumerable: true, get: function () { return countryNames_1.CountryNames; } });
+// Utility functions
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getCountryByCode2", { enumerable: true, get: function () { return utils_1.getCountryByCode2; } });
+Object.defineProperty(exports, "getCountryByCode3", { enumerable: true, get: function () { return utils_1.getCountryByCode3; } });
+Object.defineProperty(exports, "getCountryByName", { enumerable: true, get: function () { return utils_1.getCountryByName; } });
+Object.defineProperty(exports, "getCountriesByCurrency", { enumerable: true, get: function () { return utils_1.getCountriesByCurrency; } });
+Object.defineProperty(exports, "getCountriesByCallingCode", { enumerable: true, get: function () { return utils_1.getCountriesByCallingCode; } });
+Object.defineProperty(exports, "searchCountries", { enumerable: true, get: function () { return utils_1.searchCountries; } });
+Object.defineProperty(exports, "convertCountryCode", { enumerable: true, get: function () { return utils_1.convertCountryCode; } });
+Object.defineProperty(exports, "getCallingCode", { enumerable: true, get: function () { return utils_1.getCallingCode; } });
+Object.defineProperty(exports, "getCurrencyCode", { enumerable: true, get: function () { return utils_1.getCurrencyCode; } });
+Object.defineProperty(exports, "getCurrencySymbol", { enumerable: true, get: function () { return utils_1.getCurrencySymbol; } });
+Object.defineProperty(exports, "getAllCurrencies", { enumerable: true, get: function () { return utils_1.getAllCurrencies; } });
+Object.defineProperty(exports, "getAllCallingCodes", { enumerable: true, get: function () { return utils_1.getAllCallingCodes; } });
+// Validation functions
+var validators_1 = require("./validators");
+Object.defineProperty(exports, "isValidCountryCode2", { enumerable: true, get: function () { return validators_1.isValidCountryCode2; } });
+Object.defineProperty(exports, "isValidCountryCode3", { enumerable: true, get: function () { return validators_1.isValidCountryCode3; } });
+Object.defineProperty(exports, "isValidCountryCode", { enumerable: true, get: function () { return validators_1.isValidCountryCode; } });
+Object.defineProperty(exports, "isValidCountryName", { enumerable: true, get: function () { return validators_1.isValidCountryName; } });
+Object.defineProperty(exports, "isValidCurrencyCode", { enumerable: true, get: function () { return validators_1.isValidCurrencyCode; } });
+Object.defineProperty(exports, "isValidCallingCode", { enumerable: true, get: function () { return validators_1.isValidCallingCode; } });
+Object.defineProperty(exports, "validatePhoneNumber", { enumerable: true, get: function () { return validators_1.validatePhoneNumber; } });
+Object.defineProperty(exports, "parsePhoneNumber", { enumerable: true, get: function () { return validators_1.parsePhoneNumber; } });

package/dist/types.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Represents a country with all available information
+ */
+export interface Country {
+    /** Full country name (e.g., "United States") */
+    name: string;
+    /** ISO 3166-1 alpha-2 code (e.g., "US") */
+    code2: string;
+    /** ISO 3166-1 alpha-3 code (e.g., "USA") */
+    code3: string;
+    /** International calling code (e.g., "+1") */
+    callingCode: string;
+    /** ISO 4217 currency code (e.g., "USD") */
+    currencyCode: string;
+    /** Currency symbol (e.g., "$") */
+    currencySymbol: string;
+}
+/**
+ * Result of a reverse lookup operation
+ */
+export interface LookupResult {
+    /** Country name */
+    country: string;
+    /** ISO 3166-1 alpha-2 code */
+    code2: string;
+    /** ISO 3166-1 alpha-3 code */
+    code3: string;
+}
+/**
+ * Options for search and filter operations
+ */
+export interface SearchOptions {
+    /** Case-sensitive search */
+    caseSensitive?: boolean;
+    /** Exact match only */
+    exactMatch?: boolean;
+}
+/**
+ * Phone number validation result
+ */
+export interface PhoneValidationResult {
+    /** Whether the phone number is valid */
+    isValid: boolean;
+    /** Formatted phone number */
+    formatted?: string;
+    /** Country code detected */
+    countryCode?: string;
+    /** Error message if invalid */
+    error?: string;
+}
+/**
+ * Union type of all country names for better autocomplete
+ */
+export type CountryName = keyof typeof import('./twoLetterISORegionCode').TwoLetterISORegionCode;
+/**
+ * Union type of all 2-letter country codes
+ */
+export type CountryCode2 = string;
+/**
+ * Union type of all 3-letter country codes
+ */
+export type CountryCode3 = string;

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -0,0 +1,123 @@
+import { Country, SearchOptions } from './types';
+/**
+ * Get country information by 2-letter ISO code
+ * @param code - ISO 3166-1 alpha-2 code (e.g., "US", "GB", "CN")
+ * @returns Country object or null if not found
+ * @example
+ * ```ts
+ * const country = getCountryByCode2("US");
+ * // Returns: { name: "UnitedStates", code2: "US", code3: "USA", ... }
+ * ```
+ */
+export declare function getCountryByCode2(code: string): Country | null;
+/**
+ * Get country information by 3-letter ISO code
+ * @param code - ISO 3166-1 alpha-3 code (e.g., "USA", "GBR", "CHN")
+ * @returns Country object or null if not found
+ * @example
+ * ```ts
+ * const country = getCountryByCode3("USA");
+ * // Returns: { name: "UnitedStates", code2: "US", code3: "USA", ... }
+ * ```
+ */
+export declare function getCountryByCode3(code: string): Country | null;
+/**
+ * Get country information by name
+ * @param name - Country name (e.g., "UnitedStates", "United States")
+ * @returns Country object or null if not found
+ * @example
+ * ```ts
+ * const country = getCountryByName("UnitedStates");
+ * // Returns: { name: "UnitedStates", code2: "US", code3: "USA", ... }
+ * ```
+ */
+export declare function getCountryByName(name: string): Country | null;
+/**
+ * Get all countries that use a specific currency
+ * @param currencyCode - ISO 4217 currency code (e.g., "USD", "EUR")
+ * @returns Array of countries using the currency
+ * @example
+ * ```ts
+ * const countries = getCountriesByCurrency("EUR");
+ * // Returns array of European countries using Euro
+ * ```
+ */
+export declare function getCountriesByCurrency(currencyCode: string): Country[];
+/**
+ * Get all countries with a specific calling code
+ * @param callingCode - International calling code (e.g., "+1", "+44")
+ * @returns Array of countries with the calling code
+ * @example
+ * ```ts
+ * const countries = getCountriesByCallingCode("+1");
+ * // Returns: [USA, Canada, and other +1 countries]
+ * ```
+ */
+export declare function getCountriesByCallingCode(callingCode: string): Country[];
+/**
+ * Search countries by name (supports partial matching)
+ * @param query - Search query
+ * @param options - Search options
+ * @returns Array of matching countries
+ * @example
+ * ```ts
+ * const results = searchCountries("united");
+ * // Returns: [UnitedStates, UnitedKingdom, UnitedArabEmirates]
+ * ```
+ */
+export declare function searchCountries(query: string, options?: SearchOptions): Country[];
+/**
+ * Convert between 2-letter and 3-letter country codes
+ * @param code - Country code to convert
+ * @param targetFormat - Target format ('code2' or 'code3')
+ * @returns Converted code or null if not found
+ * @example
+ * ```ts
+ * convertCountryCode("US", "code3"); // Returns: "USA"
+ * convertCountryCode("GBR", "code2"); // Returns: "GB"
+ * ```
+ */
+export declare function convertCountryCode(code: string, targetFormat: 'code2' | 'code3'): string | null;
+/**
+ * Get calling code for a country
+ * @param countryIdentifier - Country name, code2, or code3
+ * @returns Calling code or null if not found
+ * @example
+ * ```ts
+ * getCallingCode("US"); // Returns: "+1"
+ * getCallingCode("UnitedStates"); // Returns: "+1"
+ * ```
+ */
+export declare function getCallingCode(countryIdentifier: string): string | null;
+/**
+ * Get currency code for a country
+ * @param countryIdentifier - Country name, code2, or code3
+ * @returns Currency code or null if not found
+ * @example
+ * ```ts
+ * getCurrencyCode("US"); // Returns: "USD"
+ * getCurrencyCode("Germany"); // Returns: "EUR"
+ * ```
+ */
+export declare function getCurrencyCode(countryIdentifier: string): string | null;
+/**
+ * Get currency symbol for a country
+ * @param countryIdentifier - Country name, code2, or code3
+ * @returns Currency symbol or null if not found
+ * @example
+ * ```ts
+ * getCurrencySymbol("US"); // Returns: "$"
+ * getCurrencySymbol("Japan"); // Returns: "¥"
+ * ```
+ */
+export declare function getCurrencySymbol(countryIdentifier: string): string | null;
+/**
+ * Get all unique currencies used worldwide
+ * @returns Array of unique currency codes
+ */
+export declare function getAllCurrencies(): string[];
+/**
+ * Get all unique calling codes
+ * @returns Array of unique calling codes
+ */
+export declare function getAllCallingCodes(): string[];