@commercelayer/react-components 4.21.0-beta.2 → 4.21.0

package/lib/esm/utils/countryStateCity.d.ts

@@ -0,0 +1,801 @@
+/**
+ * Validate the list of countries the user can optionally pass or returns our default list
+ * @param countries - Optional list of countries to override default ones
+ * @returns List of countries
+ */
+export declare function getCountries(countries?: Country[]): Country[];
+/**
+ * Get the list of states for a given country, if the user pass a list of states we use that one
+ * otherwise we use our default list.
+ * If no states are found for the given country we return an empty array.
+ * @param countryCode - code of selected country (e.g. IT)
+ * @param states - Optional list of states to override our default list
+ * @returns List of states for the selected country or empty array
+ */
+export declare function getStateOfCountry({ countryCode, states, }: {
+    countryCode: string;
+    states?: States;
+}): State[];
+/**
+ * Check if the given state is valid for the given country.
+ * If the user is overriding our default states list, it must be passed as option.
+ * @param stateCode - code of selected state
+ * @param countryCode - code of selected country
+ * @param states - Optional list of states to override our default list
+ * @returns Boolean - true if the state is valid for the given country
+ */
+export declare function isValidState({ stateCode, countryCode, states, }: {
+    stateCode: string;
+    countryCode: string;
+    states?: States;
+}): boolean;
+/**
+ * Check if the given country has a pre-defined list of states as select options.
+ * If the user is overriding our default states list, it must be specified by passing an array of countries as option.
+ */
+export declare function isEmptyStates({ countryCode, countriesWithPredefinedStateOptions, }: {
+    countryCode: string;
+    countriesWithPredefinedStateOptions?: string[];
+}): boolean;
+declare const defaultCountries: readonly [{
+    readonly label: "Afghanistan";
+    readonly value: "AF";
+}, {
+    readonly label: "Aland Islands";
+    readonly value: "AX";
+}, {
+    readonly label: "Albania";
+    readonly value: "AL";
+}, {
+    readonly label: "Algeria";
+    readonly value: "DZ";
+}, {
+    readonly label: "American Samoa";
+    readonly value: "AS";
+}, {
+    readonly label: "Andorra";
+    readonly value: "AD";
+}, {
+    readonly label: "Angola";
+    readonly value: "AO";
+}, {
+    readonly label: "Anguilla";
+    readonly value: "AI";
+}, {
+    readonly label: "Antarctica";
+    readonly value: "AQ";
+}, {
+    readonly label: "Antigua And Barbuda";
+    readonly value: "AG";
+}, {
+    readonly label: "Argentina";
+    readonly value: "AR";
+}, {
+    readonly label: "Armenia";
+    readonly value: "AM";
+}, {
+    readonly label: "Aruba";
+    readonly value: "AW";
+}, {
+    readonly label: "Australia";
+    readonly value: "AU";
+}, {
+    readonly label: "Austria";
+    readonly value: "AT";
+}, {
+    readonly label: "Azerbaijan";
+    readonly value: "AZ";
+}, {
+    readonly label: "Bahamas The";
+    readonly value: "BS";
+}, {
+    readonly label: "Bahrain";
+    readonly value: "BH";
+}, {
+    readonly label: "Bangladesh";
+    readonly value: "BD";
+}, {
+    readonly label: "Barbados";
+    readonly value: "BB";
+}, {
+    readonly label: "Belarus";
+    readonly value: "BY";
+}, {
+    readonly label: "Belgium";
+    readonly value: "BE";
+}, {
+    readonly label: "Belize";
+    readonly value: "BZ";
+}, {
+    readonly label: "Benin";
+    readonly value: "BJ";
+}, {
+    readonly label: "Bermuda";
+    readonly value: "BM";
+}, {
+    readonly label: "Bhutan";
+    readonly value: "BT";
+}, {
+    readonly label: "Bolivia";
+    readonly value: "BO";
+}, {
+    readonly label: "Bonaire, Sint Eustatius and Saba";
+    readonly value: "BQ";
+}, {
+    readonly label: "Bosnia and Herzegovina";
+    readonly value: "BA";
+}, {
+    readonly label: "Botswana";
+    readonly value: "BW";
+}, {
+    readonly label: "Bouvet Island";
+    readonly value: "BV";
+}, {
+    readonly label: "Brazil";
+    readonly value: "BR";
+}, {
+    readonly label: "British Indian Ocean Territory";
+    readonly value: "IO";
+}, {
+    readonly label: "Brunei";
+    readonly value: "BN";
+}, {
+    readonly label: "Bulgaria";
+    readonly value: "BG";
+}, {
+    readonly label: "Burkina Faso";
+    readonly value: "BF";
+}, {
+    readonly label: "Burundi";
+    readonly value: "BI";
+}, {
+    readonly label: "Cambodia";
+    readonly value: "KH";
+}, {
+    readonly label: "Cameroon";
+    readonly value: "CM";
+}, {
+    readonly label: "Canada";
+    readonly value: "CA";
+}, {
+    readonly label: "Cape Verde";
+    readonly value: "CV";
+}, {
+    readonly label: "Cayman Islands";
+    readonly value: "KY";
+}, {
+    readonly label: "Central African Republic";
+    readonly value: "CF";
+}, {
+    readonly label: "Chad";
+    readonly value: "TD";
+}, {
+    readonly label: "Chile";
+    readonly value: "CL";
+}, {
+    readonly label: "China";
+    readonly value: "CN";
+}, {
+    readonly label: "Christmas Island";
+    readonly value: "CX";
+}, {
+    readonly label: "Cocos (Keeling) Islands";
+    readonly value: "CC";
+}, {
+    readonly label: "Colombia";
+    readonly value: "CO";
+}, {
+    readonly label: "Comoros";
+    readonly value: "KM";
+}, {
+    readonly label: "Congo";
+    readonly value: "CG";
+}, {
+    readonly label: "Cook Islands";
+    readonly value: "CK";
+}, {
+    readonly label: "Costa Rica";
+    readonly value: "CR";
+}, {
+    readonly label: "Cote D'Ivoire (Ivory Coast)";
+    readonly value: "CI";
+}, {
+    readonly label: "Croatia";
+    readonly value: "HR";
+}, {
+    readonly label: "Cuba";
+    readonly value: "CU";
+}, {
+    readonly label: "Curaçao";
+    readonly value: "CW";
+}, {
+    readonly label: "Cyprus";
+    readonly value: "CY";
+}, {
+    readonly label: "Czech Republic";
+    readonly value: "CZ";
+}, {
+    readonly label: "Democratic Republic of the Congo";
+    readonly value: "CD";
+}, {
+    readonly label: "Denmark";
+    readonly value: "DK";
+}, {
+    readonly label: "Djibouti";
+    readonly value: "DJ";
+}, {
+    readonly label: "Dominica";
+    readonly value: "DM";
+}, {
+    readonly label: "Dominican Republic";
+    readonly value: "DO";
+}, {
+    readonly label: "East Timor";
+    readonly value: "TL";
+}, {
+    readonly label: "Ecuador";
+    readonly value: "EC";
+}, {
+    readonly label: "Egypt";
+    readonly value: "EG";
+}, {
+    readonly label: "El Salvador";
+    readonly value: "SV";
+}, {
+    readonly label: "Equatorial Guinea";
+    readonly value: "GQ";
+}, {
+    readonly label: "Eritrea";
+    readonly value: "ER";
+}, {
+    readonly label: "Estonia";
+    readonly value: "EE";
+}, {
+    readonly label: "Ethiopia";
+    readonly value: "ET";
+}, {
+    readonly label: "Falkland Islands";
+    readonly value: "FK";
+}, {
+    readonly label: "Faroe Islands";
+    readonly value: "FO";
+}, {
+    readonly label: "Fiji Islands";
+    readonly value: "FJ";
+}, {
+    readonly label: "Finland";
+    readonly value: "FI";
+}, {
+    readonly label: "France";
+    readonly value: "FR";
+}, {
+    readonly label: "French Guiana";
+    readonly value: "GF";
+}, {
+    readonly label: "French Polynesia";
+    readonly value: "PF";
+}, {
+    readonly label: "French Southern Territories";
+    readonly value: "TF";
+}, {
+    readonly label: "Gabon";
+    readonly value: "GA";
+}, {
+    readonly label: "Gambia The";
+    readonly value: "GM";
+}, {
+    readonly label: "Georgia";
+    readonly value: "GE";
+}, {
+    readonly label: "Germany";
+    readonly value: "DE";
+}, {
+    readonly label: "Ghana";
+    readonly value: "GH";
+}, {
+    readonly label: "Gibraltar";
+    readonly value: "GI";
+}, {
+    readonly label: "Greece";
+    readonly value: "GR";
+}, {
+    readonly label: "Greenland";
+    readonly value: "GL";
+}, {
+    readonly label: "Grenada";
+    readonly value: "GD";
+}, {
+    readonly label: "Guadeloupe";
+    readonly value: "GP";
+}, {
+    readonly label: "Guam";
+    readonly value: "GU";
+}, {
+    readonly label: "Guatemala";
+    readonly value: "GT";
+}, {
+    readonly label: "Guernsey and Alderney";
+    readonly value: "GG";
+}, {
+    readonly label: "Guinea";
+    readonly value: "GN";
+}, {
+    readonly label: "Guinea-Bissau";
+    readonly value: "GW";
+}, {
+    readonly label: "Guyana";
+    readonly value: "GY";
+}, {
+    readonly label: "Haiti";
+    readonly value: "HT";
+}, {
+    readonly label: "Heard Island and McDonald Islands";
+    readonly value: "HM";
+}, {
+    readonly label: "Honduras";
+    readonly value: "HN";
+}, {
+    readonly label: "Hong Kong S.A.R.";
+    readonly value: "HK";
+}, {
+    readonly label: "Hungary";
+    readonly value: "HU";
+}, {
+    readonly label: "Iceland";
+    readonly value: "IS";
+}, {
+    readonly label: "India";
+    readonly value: "IN";
+}, {
+    readonly label: "Indonesia";
+    readonly value: "ID";
+}, {
+    readonly label: "Iran";
+    readonly value: "IR";
+}, {
+    readonly label: "Iraq";
+    readonly value: "IQ";
+}, {
+    readonly label: "Ireland";
+    readonly value: "IE";
+}, {
+    readonly label: "Israel";
+    readonly value: "IL";
+}, {
+    readonly label: "Italy";
+    readonly value: "IT";
+}, {
+    readonly label: "Jamaica";
+    readonly value: "JM";
+}, {
+    readonly label: "Japan";
+    readonly value: "JP";
+}, {
+    readonly label: "Jersey";
+    readonly value: "JE";
+}, {
+    readonly label: "Jordan";
+    readonly value: "JO";
+}, {
+    readonly label: "Kazakhstan";
+    readonly value: "KZ";
+}, {
+    readonly label: "Kenya";
+    readonly value: "KE";
+}, {
+    readonly label: "Kiribati";
+    readonly value: "KI";
+}, {
+    readonly label: "Kosovo";
+    readonly value: "XK";
+}, {
+    readonly label: "Kuwait";
+    readonly value: "KW";
+}, {
+    readonly label: "Kyrgyzstan";
+    readonly value: "KG";
+}, {
+    readonly label: "Laos";
+    readonly value: "LA";
+}, {
+    readonly label: "Latvia";
+    readonly value: "LV";
+}, {
+    readonly label: "Lebanon";
+    readonly value: "LB";
+}, {
+    readonly label: "Lesotho";
+    readonly value: "LS";
+}, {
+    readonly label: "Liberia";
+    readonly value: "LR";
+}, {
+    readonly label: "Libya";
+    readonly value: "LY";
+}, {
+    readonly label: "Liechtenstein";
+    readonly value: "LI";
+}, {
+    readonly label: "Lithuania";
+    readonly value: "LT";
+}, {
+    readonly label: "Luxembourg";
+    readonly value: "LU";
+}, {
+    readonly label: "Macau S.A.R.";
+    readonly value: "MO";
+}, {
+    readonly label: "Macedonia";
+    readonly value: "MK";
+}, {
+    readonly label: "Madagascar";
+    readonly value: "MG";
+}, {
+    readonly label: "Malawi";
+    readonly value: "MW";
+}, {
+    readonly label: "Malaysia";
+    readonly value: "MY";
+}, {
+    readonly label: "Maldives";
+    readonly value: "MV";
+}, {
+    readonly label: "Mali";
+    readonly value: "ML";
+}, {
+    readonly label: "Malta";
+    readonly value: "MT";
+}, {
+    readonly label: "Man (Isle of)";
+    readonly value: "IM";
+}, {
+    readonly label: "Marshall Islands";
+    readonly value: "MH";
+}, {
+    readonly label: "Martinique";
+    readonly value: "MQ";
+}, {
+    readonly label: "Mauritania";
+    readonly value: "MR";
+}, {
+    readonly label: "Mauritius";
+    readonly value: "MU";
+}, {
+    readonly label: "Mayotte";
+    readonly value: "YT";
+}, {
+    readonly label: "Mexico";
+    readonly value: "MX";
+}, {
+    readonly label: "Micronesia";
+    readonly value: "FM";
+}, {
+    readonly label: "Moldova";
+    readonly value: "MD";
+}, {
+    readonly label: "Monaco";
+    readonly value: "MC";
+}, {
+    readonly label: "Mongolia";
+    readonly value: "MN";
+}, {
+    readonly label: "Montenegro";
+    readonly value: "ME";
+}, {
+    readonly label: "Montserrat";
+    readonly value: "MS";
+}, {
+    readonly label: "Morocco";
+    readonly value: "MA";
+}, {
+    readonly label: "Mozambique";
+    readonly value: "MZ";
+}, {
+    readonly label: "Myanmar";
+    readonly value: "MM";
+}, {
+    readonly label: "Namibia";
+    readonly value: "NA";
+}, {
+    readonly label: "Nauru";
+    readonly value: "NR";
+}, {
+    readonly label: "Nepal";
+    readonly value: "NP";
+}, {
+    readonly label: "Netherlands";
+    readonly value: "NL";
+}, {
+    readonly label: "New Caledonia";
+    readonly value: "NC";
+}, {
+    readonly label: "New Zealand";
+    readonly value: "NZ";
+}, {
+    readonly label: "Nicaragua";
+    readonly value: "NI";
+}, {
+    readonly label: "Niger";
+    readonly value: "NE";
+}, {
+    readonly label: "Nigeria";
+    readonly value: "NG";
+}, {
+    readonly label: "Niue";
+    readonly value: "NU";
+}, {
+    readonly label: "Norfolk Island";
+    readonly value: "NF";
+}, {
+    readonly label: "North Korea";
+    readonly value: "KP";
+}, {
+    readonly label: "Northern Mariana Islands";
+    readonly value: "MP";
+}, {
+    readonly label: "Norway";
+    readonly value: "NO";
+}, {
+    readonly label: "Oman";
+    readonly value: "OM";
+}, {
+    readonly label: "Pakistan";
+    readonly value: "PK";
+}, {
+    readonly label: "Palau";
+    readonly value: "PW";
+}, {
+    readonly label: "Palestinian Territory Occupied";
+    readonly value: "PS";
+}, {
+    readonly label: "Panama";
+    readonly value: "PA";
+}, {
+    readonly label: "Papua new Guinea";
+    readonly value: "PG";
+}, {
+    readonly label: "Paraguay";
+    readonly value: "PY";
+}, {
+    readonly label: "Peru";
+    readonly value: "PE";
+}, {
+    readonly label: "Philippines";
+    readonly value: "PH";
+}, {
+    readonly label: "Pitcairn Island";
+    readonly value: "PN";
+}, {
+    readonly label: "Poland";
+    readonly value: "PL";
+}, {
+    readonly label: "Portugal";
+    readonly value: "PT";
+}, {
+    readonly label: "Puerto Rico";
+    readonly value: "PR";
+}, {
+    readonly label: "Qatar";
+    readonly value: "QA";
+}, {
+    readonly label: "Reunion";
+    readonly value: "RE";
+}, {
+    readonly label: "Romania";
+    readonly value: "RO";
+}, {
+    readonly label: "Russia";
+    readonly value: "RU";
+}, {
+    readonly label: "Rwanda";
+    readonly value: "RW";
+}, {
+    readonly label: "Saint Helena";
+    readonly value: "SH";
+}, {
+    readonly label: "Saint Kitts And Nevis";
+    readonly value: "KN";
+}, {
+    readonly label: "Saint Lucia";
+    readonly value: "LC";
+}, {
+    readonly label: "Saint Pierre and Miquelon";
+    readonly value: "PM";
+}, {
+    readonly label: "Saint Vincent And The Grenadines";
+    readonly value: "VC";
+}, {
+    readonly label: "Saint-Barthelemy";
+    readonly value: "BL";
+}, {
+    readonly label: "Saint-Martin (French part)";
+    readonly value: "MF";
+}, {
+    readonly label: "Samoa";
+    readonly value: "WS";
+}, {
+    readonly label: "San Marino";
+    readonly value: "SM";
+}, {
+    readonly label: "Sao Tome and Principe";
+    readonly value: "ST";
+}, {
+    readonly label: "Saudi Arabia";
+    readonly value: "SA";
+}, {
+    readonly label: "Senegal";
+    readonly value: "SN";
+}, {
+    readonly label: "Serbia";
+    readonly value: "RS";
+}, {
+    readonly label: "Seychelles";
+    readonly value: "SC";
+}, {
+    readonly label: "Sierra Leone";
+    readonly value: "SL";
+}, {
+    readonly label: "Singapore";
+    readonly value: "SG";
+}, {
+    readonly label: "Sint Maarten (Dutch part)";
+    readonly value: "SX";
+}, {
+    readonly label: "Slovakia";
+    readonly value: "SK";
+}, {
+    readonly label: "Slovenia";
+    readonly value: "SI";
+}, {
+    readonly label: "Solomon Islands";
+    readonly value: "SB";
+}, {
+    readonly label: "Somalia";
+    readonly value: "SO";
+}, {
+    readonly label: "South Africa";
+    readonly value: "ZA";
+}, {
+    readonly label: "South Georgia";
+    readonly value: "GS";
+}, {
+    readonly label: "South Korea";
+    readonly value: "KR";
+}, {
+    readonly label: "South Sudan";
+    readonly value: "SS";
+}, {
+    readonly label: "Spain";
+    readonly value: "ES";
+}, {
+    readonly label: "Sri Lanka";
+    readonly value: "LK";
+}, {
+    readonly label: "Sudan";
+    readonly value: "SD";
+}, {
+    readonly label: "Suriname";
+    readonly value: "SR";
+}, {
+    readonly label: "Svalbard And Jan Mayen Islands";
+    readonly value: "SJ";
+}, {
+    readonly label: "Swaziland";
+    readonly value: "SZ";
+}, {
+    readonly label: "Sweden";
+    readonly value: "SE";
+}, {
+    readonly label: "Switzerland";
+    readonly value: "CH";
+}, {
+    readonly label: "Syria";
+    readonly value: "SY";
+}, {
+    readonly label: "Taiwan";
+    readonly value: "TW";
+}, {
+    readonly label: "Tajikistan";
+    readonly value: "TJ";
+}, {
+    readonly label: "Tanzania";
+    readonly value: "TZ";
+}, {
+    readonly label: "Thailand";
+    readonly value: "TH";
+}, {
+    readonly label: "Togo";
+    readonly value: "TG";
+}, {
+    readonly label: "Tokelau";
+    readonly value: "TK";
+}, {
+    readonly label: "Tonga";
+    readonly value: "TO";
+}, {
+    readonly label: "Trinidad And Tobago";
+    readonly value: "TT";
+}, {
+    readonly label: "Tunisia";
+    readonly value: "TN";
+}, {
+    readonly label: "Turkey";
+    readonly value: "TR";
+}, {
+    readonly label: "Turkmenistan";
+    readonly value: "TM";
+}, {
+    readonly label: "Turks And Caicos Islands";
+    readonly value: "TC";
+}, {
+    readonly label: "Tuvalu";
+    readonly value: "TV";
+}, {
+    readonly label: "Uganda";
+    readonly value: "UG";
+}, {
+    readonly label: "Ukraine";
+    readonly value: "UA";
+}, {
+    readonly label: "United Arab Emirates";
+    readonly value: "AE";
+}, {
+    readonly label: "United Kingdom";
+    readonly value: "GB";
+}, {
+    readonly label: "United States";
+    readonly value: "US";
+}, {
+    readonly label: "United States Minor Outlying Islands";
+    readonly value: "UM";
+}, {
+    readonly label: "Uruguay";
+    readonly value: "UY";
+}, {
+    readonly label: "Uzbekistan";
+    readonly value: "UZ";
+}, {
+    readonly label: "Vanuatu";
+    readonly value: "VU";
+}, {
+    readonly label: "Vatican City State (Holy See)";
+    readonly value: "VA";
+}, {
+    readonly label: "Venezuela";
+    readonly value: "VE";
+}, {
+    readonly label: "Vietnam";
+    readonly value: "VN";
+}, {
+    readonly label: "Virgin Islands (British)";
+    readonly value: "VG";
+}, {
+    readonly label: "Virgin Islands (US)";
+    readonly value: "VI";
+}, {
+    readonly label: "Wallis And Futuna Islands";
+    readonly value: "WF";
+}, {
+    readonly label: "Western Sahara";
+    readonly value: "EH";
+}, {
+    readonly label: "Yemen";
+    readonly value: "YE";
+}, {
+    readonly label: "Zambia";
+    readonly value: "ZM";
+}, {
+    readonly label: "Zimbabwe";
+    readonly value: "ZW";
+}];
+type CountryCode = (typeof defaultCountries)[number]["value"];
+export interface Country {
+    value: CountryCode;
+    label: string;
+}
+interface State {
+    label: string;
+    value: string;
+}
+export type States = Partial<Record<CountryCode, State[]>>;
+export {};