react-country-kit-core 1.3.0 → 2.0.0

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export interface PhoneFormat {
+export interface IPhoneFormat {
     iso2: string;
     dialCode: string;
     patterns: string;
@@ -6,14 +6,14 @@ export interface PhoneFormat {
     example: string | number;
     countryCode: string;
 }
-export interface Currency {
+export interface ICurrency {
     code: string;
     name: string;
     symbol: string;
     countryCode: string;
     precision: number;
 }
-export interface Timezone {
+export interface ITimezone {
     name: string;
     offset: number;
     offset_name: string;
@@ -21,13 +21,13 @@ export interface Timezone {
     tzName: string;
     countryCode: string;
 }
-export interface Division {
+export interface IDivision {
     name: string;
     iso2: string;
     timezone: string;
     countryCode: string;
 }
-export interface Country {
+export interface ICountry {
     name: string;
     iso2: string;
     iso3: string;
@@ -48,16 +48,16 @@ export interface Country {
     /** Label for postal/zip code (e.g. "ZIP Code", "Postcode", "PIN Code") */
     postal_code_label: string;
 }
-export interface Language {
+export interface ILanguage {
     code: string;
     english_name: string;
     native_name: string;
 }
-export interface CountryPickerProps {
+export interface ICountryPickerProps {
     /** Currently selected country */
-    value?: Country | null;
+    value?: ICountry | null;
     /** Callback when user selects a country */
-    onChange: (country: Country) => void;
+    onChange: (country: ICountry) => void;
     placeholder?: string;
     /** Enable search input */
     searchable?: boolean;
@@ -72,9 +72,9 @@ export interface CountryPickerProps {
     /** aria-label */
     label?: string;
 }
-export interface CurrencyPickerProps {
-    value?: Currency | null;
-    onChange: (currency: Currency) => void;
+export interface ICurrencyPickerProps {
+    value?: ICurrency | null;
+    onChange: (currency: ICurrency) => void;
     placeholder?: string;
     searchable?: boolean;
     /** Filter currencies to a specific country (iso2) and enable auto-selection */
@@ -87,9 +87,9 @@ export interface CurrencyPickerProps {
     className?: string;
     label?: string;
 }
-export interface TimezonePickerProps {
-    value?: Timezone | null;
-    onChange: (timezone: Timezone) => void;
+export interface ITimezonePickerProps {
+    value?: ITimezone | null;
+    onChange: (timezone: ITimezone) => void;
     placeholder?: string;
     searchable?: boolean;
     /** Filter timezones to a specific country (iso2) and enable auto-selection */
@@ -100,9 +100,9 @@ export interface TimezonePickerProps {
     className?: string;
     label?: string;
 }
-export interface LanguagePickerProps {
-    value?: Language | null;
-    onChange: (language: Language) => void;
+export interface ILanguagePickerProps {
+    value?: ILanguage | null;
+    onChange: (language: ILanguage) => void;
     placeholder?: string;
     searchable?: boolean;
     /** Show native language name alongside english name */
@@ -111,18 +111,18 @@ export interface LanguagePickerProps {
     className?: string;
     label?: string;
 }
-export interface DivisionPickerProps {
+export interface IDivisionPickerProps {
     /** ISO2 code of the parent country (required) */
     countryIso2: string;
-    value?: Division | null;
-    onChange: (division: Division) => void;
+    value?: IDivision | null;
+    onChange: (division: IDivision) => void;
     placeholder?: string;
     searchable?: boolean;
     disabled?: boolean;
     className?: string;
     label?: string;
 }
-export interface UsePickerReturn<T> {
+export interface IUsePickerReturn<T> {
     isOpen: boolean;
     searchQuery: string;
     filteredItems: T[];
@@ -134,22 +134,39 @@ export interface UsePickerReturn<T> {
     selectItem: (item: T) => void;
     clearSelection: () => void;
 }
+/**
+ * Phone number validation rules and metadata for a country
+ */
+export interface IPhoneValidation {
+    /** Min phone number length (without dial code) */
+    minLength?: number;
+    /** Max phone number length (without dial code) */
+    maxLength?: number;
+    /** Regex pattern for validation */
+    pattern?: string;
+    /** Example phone number without dial code */
+    example?: string;
+    /** Placeholder text for the phone input */
+    placeholder?: string;
+}
 /**
  * Value object returned by PhoneInput.
  */
-export interface PhoneValue {
+export interface IPhoneValue {
     /** Full Country object of the selected country */
-    country: Country;
+    country: ICountry;
     /** Dial code with + prefix, e.g. "+1" */
     dialCode: string;
     /** Raw phone number without dial code, e.g. "4155551234" */
     number: string;
     /** Full number with dial code, e.g. "+14155551234" */
     full: string;
+    /** Validation rules and metadata for the phone number */
+    validation?: IPhoneValidation;
 }
-export interface PhoneInputProps {
-    value?: PhoneValue | null;
-    onChange: (value: PhoneValue) => void;
+export interface IPhoneInputProps {
+    value?: IPhoneValue | null;
+    onChange: (value: IPhoneValue) => void;
     /** Pre-select a country by ISO2 on first render */
     defaultCountryIso2?: string;
     placeholder?: string;
@@ -158,9 +175,9 @@ export interface PhoneInputProps {
     className?: string;
     label?: string;
 }
-export interface CountryMultiSelectProps {
-    value: Country[];
-    onChange: (countries: Country[]) => void;
+export interface ICountryMultiSelectProps {
+    value: ICountry[];
+    onChange: (countries: ICountry[]) => void;
     placeholder?: string;
     /** Maximum number of selections (undefined = unlimited) */
     maxItems?: number;
@@ -170,9 +187,9 @@ export interface CountryMultiSelectProps {
     className?: string;
     label?: string;
 }
-export interface CurrencyMultiSelectProps {
-    value: Currency[];
-    onChange: (currencies: Currency[]) => void;
+export interface ICurrencyMultiSelectProps {
+    value: ICurrency[];
+    onChange: (currencies: ICurrency[]) => void;
     placeholder?: string;
     maxItems?: number;
     showSymbol?: boolean;
@@ -181,7 +198,7 @@ export interface CurrencyMultiSelectProps {
     className?: string;
     label?: string;
 }
-export interface UseMultiSelectReturn<T> {
+export interface IUseMultiSelectReturn<T> {
     isOpen: boolean;
     searchQuery: string;
     filteredItems: T[];
@@ -195,3 +212,22 @@ export interface UseMultiSelectReturn<T> {
     removeItem: (item: T) => void;
     clearAll: () => void;
 }
+export interface IUseCountryReturn {
+    country: ICountry | null;
+    divisions: IDivision[];
+    timezones: ITimezone[];
+    currency: ICurrency | null;
+    phoneFormat: IPhoneFormat | null;
+    phoneLengths: {
+        min?: number;
+        max?: number;
+    };
+    exampleNumber?: string;
+    tax: {
+        label: string;
+        placeholder: string;
+    };
+    postalCode: {
+        label: string;
+    };
+}

package/dist/utils/countries.d.ts

@@ -1,5 +1,5 @@
 import { iso2ToFlag as _iso2ToFlag } from '../data/countries';
-import { Country, Currency, Division, PhoneFormat, Timezone } from '../types';
+import { ICountry, ICurrency, IDivision, IPhoneFormat, ITimezone } from '../types';
 /**
  * Convert ISO2 code to emoji flag
  * Re-exported from the generated data module.
@@ -8,42 +8,39 @@ export { _iso2ToFlag as iso2ToFlag };
 /**
  * Returns all countries
  */
-export declare function getAllCountries(): Country[];
+export declare function getAllCountries(): ICountry[];
 /**
  * Find a country by its ISO2 code (case-insensitive)
  */
-export declare function getCountryByIso2(iso2: string): Country | undefined;
+export declare function getCountryByIso2(iso2: string): ICountry | undefined;
 /**
  * Find a country by its ISO3 code (case-insensitive)
  */
-export declare function getCountryByIso3(iso3: string): Country | undefined;
+export declare function getCountryByIso3(iso3: string): ICountry | undefined;
 /**
  * Find a country by its name (partial, case-insensitive)
  */
-export declare function getCountryByName(name: string): Country | undefined;
+export declare function getCountryByName(name: string): ICountry | undefined;
 /**
  * Search countries by name, iso2, iso3 or phone code
  */
-export declare function searchCountries(query: string): Country[];
+export declare function searchCountries(query: string): ICountry[];
 /**
  * Get all divisions for a country
  */
-export declare function getDivisionsByCountry(iso2: string): Division[];
+export declare function getDivisionsByCountry(iso2: string): IDivision[];
 /**
  * Get all timezones for a country
  */
-export declare function getTimezonesByCountry(iso2: string): Timezone[];
-/**
- * Get the currency of a country
- */
+export declare function getTimezonesByCountry(iso2: string): ITimezone[];
 /**
  * Get the currency for a country
  */
-export declare function getCurrencyByCountry(iso2: string): Currency | undefined;
+export declare function getCurrencyByCountry(iso2: string): ICurrency | undefined;
 /**
  * Get the phone format for a country
  */
-export declare function getPhoneFormatByCountry(iso2: string): PhoneFormat | undefined;
+export declare function getPhoneFormatByCountry(iso2: string): IPhoneFormat | undefined;
 /**
  * Get the min and max phone number lengths for a country
  */

package/dist/utils/currencies.d.ts

@@ -1,13 +1,13 @@
-import { Currency } from '../types';
+import { ICurrency } from '../types';
 /**
  * Returns all unique currencies across all countries
  */
-export declare function getAllCurrencies(): Currency[];
+export declare function getAllCurrencies(): ICurrency[];
 /**
  * Find a currency by its code (e.g. "USD")
  */
-export declare function getCurrencyByCode(code: string): Currency | undefined;
+export declare function getCurrencyByCode(code: string): ICurrency | undefined;
 /**
  * Search currencies by code, name, or symbol
  */
-export declare function searchCurrencies(query: string, countryIso2?: string): Currency[];
+export declare function searchCurrencies(query: string, countryIso2?: string): ICurrency[];

package/dist/utils/languages.d.ts

@@ -1,13 +1,13 @@
-import { Language } from '../types';
+import { ILanguage } from '../types';
 /**
  * Returns all languages
  */
-export declare function getAllLanguages(): Language[];
+export declare function getAllLanguages(): ILanguage[];
 /**
  * Find a language by its BCP-47 code
  */
-export declare function getLanguageByCode(code: string): Language | undefined;
+export declare function getLanguageByCode(code: string): ILanguage | undefined;
 /**
  * Search languages by english name, native name, or code
  */
-export declare function searchLanguages(query: string): Language[];
+export declare function searchLanguages(query: string): ILanguage[];

package/dist/utils/phone.d.ts

@@ -0,0 +1,21 @@
+import { IPhoneValidation } from '../types';
+/**
+ * Get phone number validation rules for a country
+ * Combines libphonenumber-js data with custom formatting rules
+ */
+export declare function getPhoneValidation(countryIso2: string): IPhoneValidation;
+/**
+ * Format phone example as a user-friendly placeholder
+ */
+export declare function formatPhoneExample(example: string, countryIso2: string): string;
+/**
+ * Validate phone number against country-specific rules
+ */
+export declare function validatePhoneNumber(dialCode: string, number: string, countryIso2: string): {
+    isValid: boolean;
+    errors: string[];
+};
+/**
+ * Format phone number for display based on country conventions
+ */
+export declare function formatPhoneNumber(number: string, countryIso2: string): string;

package/dist/utils/timezones.d.ts

@@ -1,14 +1,14 @@
-import { Timezone } from '../types';
+import { ITimezone } from '../types';
 /**
  * Returns all unique timezones across all countries
  */
-export declare function getAllTimezones(): Timezone[];
+export declare function getAllTimezones(): ITimezone[];
 /**
  * Find a timezone by its IANA name (e.g. "America/New_York")
  * Supports modern names and common deprecated aliases.
  */
-export declare function getTimezoneByName(name: string): Timezone | undefined;
+export declare function getTimezoneByName(name: string): ITimezone | undefined;
 /**
  * Search timezones by name, abbreviation, or offset string
  */
-export declare function searchTimezones(query: string, countryIso2?: string): Timezone[];
+export declare function searchTimezones(query: string, countryIso2?: string): ITimezone[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-country-kit-core",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "type": "module",
   "description": "Core datasets, utilities, and hooks for react-country-kit. Comprehensive data for countries, currencies, timezones, languages, and divisions.",
   "author": "Kishor Mainali",