intl-tel-input 27.3.1 → 28.0.0

package/dist/js/intlTelInput.d.ts

@@ -1599,7 +1599,7 @@ export type Country = {
 	areaCodes: readonly string[] | null;
 	nationalPrefix: string | null;
 };
-export type I18n = Partial<Record<Iso2, string>> & {
+export type I18n = {
 	selectedCountryAriaLabel?: string;
 	searchPlaceholder?: string;
 	clearSearchAriaLabel?: string;
@@ -1613,6 +1613,12 @@ declare const PLACEHOLDER_MODES: {
 	readonly POLITE: "polite";
 	readonly OFF: "off";
 };
+declare const NUMBER_FORMATS: readonly [
+	"E164",
+	"INTERNATIONAL",
+	"NATIONAL",
+	"RFC3966"
+];
 declare const NUMBER_TYPES: readonly [
 	"FIXED_LINE",
 	"MOBILE",
@@ -1627,54 +1633,60 @@ declare const NUMBER_TYPES: readonly [
 	"VOICEMAIL",
 	"UNKNOWN"
 ];
-declare const NUMBER_TYPE_SET: ReadonlySet<(typeof NUMBER_TYPES)[number]> & {
-	has(value: string): boolean;
-};
+declare const VALIDATION_ERRORS: readonly [
+	"IS_POSSIBLE",
+	"INVALID_COUNTRY_CODE",
+	"TOO_SHORT",
+	"TOO_LONG",
+	"IS_POSSIBLE_LOCAL_ONLY",
+	"INVALID_LENGTH"
+];
+export declare const NUMBER_FORMAT: Readonly<{
+	E164: "E164";
+	INTERNATIONAL: "INTERNATIONAL";
+	NATIONAL: "NATIONAL";
+	RFC3966: "RFC3966";
+}>;
+export declare const NUMBER_TYPE: Readonly<{
+	FIXED_LINE: "FIXED_LINE";
+	MOBILE: "MOBILE";
+	FIXED_LINE_OR_MOBILE: "FIXED_LINE_OR_MOBILE";
+	TOLL_FREE: "TOLL_FREE";
+	PREMIUM_RATE: "PREMIUM_RATE";
+	SHARED_COST: "SHARED_COST";
+	VOIP: "VOIP";
+	PERSONAL_NUMBER: "PERSONAL_NUMBER";
+	PAGER: "PAGER";
+	UAN: "UAN";
+	VOICEMAIL: "VOICEMAIL";
+	UNKNOWN: "UNKNOWN";
+}>;
+export declare const VALIDATION_ERROR: Readonly<{
+	IS_POSSIBLE: "IS_POSSIBLE";
+	INVALID_COUNTRY_CODE: "INVALID_COUNTRY_CODE";
+	TOO_SHORT: "TOO_SHORT";
+	TOO_LONG: "TOO_LONG";
+	IS_POSSIBLE_LOCAL_ONLY: "IS_POSSIBLE_LOCAL_ONLY";
+	INVALID_LENGTH: "INVALID_LENGTH";
+}>;
 export type UtilsLoader = () => Promise<{
 	default: ItiUtils;
 }>;
 export type ItiUtils = {
-	formatNumber(number: string, iso2: string | undefined, format?: number): string;
+	formatNumber(number: string, iso2: string | undefined, format?: NumberFormat): string;
 	formatNumberAsYouType(number: string, iso2: string | undefined): string;
 	getCoreNumber(number: string, iso2: string | undefined): string;
-	getExampleNumber(iso2: string | undefined, nationalMode: boolean, numberType: number, useE164?: boolean): string;
+	getExampleNumber(iso2: string | undefined, nationalMode: boolean, numberType: NumberType, useE164?: boolean): string;
 	getExtension(number: string, iso2: string | undefined): string;
-	getNumberType(number: string, iso2: string | undefined): number;
-	getValidationError(number: string, iso2: string | undefined): number;
+	getNumberType(number: string, iso2: string | undefined): NumberType | null;
+	getValidationError(number: string, iso2: string | undefined): ValidationError | null;
 	isPossibleNumber(number: string, iso2: string | undefined, numberType?: NumberType[] | null): boolean;
 	isValidNumber(number: string, iso2: string | undefined, numberType?: NumberType[] | null): boolean;
-	numberFormat: {
-		NATIONAL: number;
-		INTERNATIONAL: number;
-		E164: number;
-		RFC3966: number;
-	};
-	numberType: {
-		[key: string]: number;
-		FIXED_LINE: number;
-		MOBILE: number;
-		FIXED_LINE_OR_MOBILE: number;
-		TOLL_FREE: number;
-		PREMIUM_RATE: number;
-		SHARED_COST: number;
-		VOIP: number;
-		PERSONAL_NUMBER: number;
-		PAGER: number;
-		UAN: number;
-		VOICEMAIL: number;
-		UNKNOWN: number;
-	};
-	validationError: {
-		IS_POSSIBLE: number;
-		INVALID_COUNTRY_CODE: number;
-		TOO_SHORT: number;
-		TOO_LONG: number;
-		IS_POSSIBLE_LOCAL_ONLY: number;
-		INVALID_LENGTH: number;
-	};
 };
-export type SetValues<T> = T extends ReadonlySet<infer U> ? U : never;
-export type NumberType = SetValues<typeof NUMBER_TYPE_SET>;
+export type ArrayValues<T extends readonly unknown[]> = T[number];
+export type NumberFormat = ArrayValues<typeof NUMBER_FORMATS>;
+export type NumberType = ArrayValues<typeof NUMBER_TYPES>;
+export type ValidationError = ArrayValues<typeof VALIDATION_ERRORS>;
 export type ValueOf<T> = T[keyof T];
 export interface AllOptions {
 	allowDropdown: boolean;
@@ -1684,6 +1696,7 @@ export interface AllOptions {
 	autoPlaceholder: ValueOf<typeof PLACEHOLDER_MODES>;
 	containerClass: string;
 	countryNameLocale: string;
+	countryNameOverrides: Partial<Record<Iso2, string>>;
 	countryOrder: Iso2[] | null;
 	countrySearch: boolean;
 	customPlaceholder: ((selectedCountryPlaceholder: string, selectedCountryData: SelectedCountryData) => string) | null;
@@ -1693,7 +1706,7 @@ export interface AllOptions {
 	fixDropdownWidth: boolean;
 	formatAsYouType: boolean;
 	formatOnDisplay: boolean;
-	geoIpLookup: ((success: (iso2: Iso2) => void, failure: () => void) => void) | null;
+	geoIpLookup: (() => Promise<Iso2>) | null;
 	hiddenInput: ((telInputName: string) => {
 		phone: string;
 		country?: string;
@@ -1712,7 +1725,7 @@ export interface AllOptions {
 	useFullscreenPopup: boolean;
 }
 export type SomeOptions = Partial<AllOptions>;
-export type SelectedCountryData = Pick<Country, "iso2" | "dialCode" | "name"> | null;
+export type SelectedCountryData = Country | null;
 export type ForEachInstanceArgsMap = {
 	handleUtilsLoaded: [
 	];
@@ -1732,10 +1745,10 @@ export declare class Iti {
 	destroy(): void;
 	isActive(): boolean;
 	getExtension(): string;
-	getNumber(format?: number): string;
-	getNumberType(): number;
+	getNumber(format?: NumberFormat): string;
+	getNumberType(): NumberType | null;
 	getSelectedCountryData(): SelectedCountryData;
-	getValidationError(): number;
+	getValidationError(): ValidationError | null;
 	isValidNumber(): boolean | null;
 	isValidNumberPrecise(): boolean | null;
 	setCountry(iso2: Iso2): void;
@@ -1753,11 +1766,14 @@ export interface IntlTelInputInterface {
 	getCountryData: () => Country[];
 	getInstance: (input: HTMLInputElement) => Iti | null;
 	instances: Map<string, Iti>;
-	attachUtils: (source: UtilsLoader) => Promise<unknown> | null;
+	attachUtils: (source: UtilsLoader) => Promise<boolean | null>;
 	startedLoadingAutoCountry: boolean;
 	startedLoadingUtils: boolean;
 	version: string | undefined;
 	utils?: ItiUtils;
+	NUMBER_FORMAT: typeof NUMBER_FORMAT;
+	NUMBER_TYPE: typeof NUMBER_TYPE;
+	VALIDATION_ERROR: typeof VALIDATION_ERROR;
 }
 declare const intlTelInput: IntlTelInputInterface;