react-country-kit-core 1.2.0 → 2.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,233 @@
+export interface IPhoneFormat {
+    iso2: string;
+    dialCode: string;
+    patterns: string;
+    possibleLengths: string;
+    example: string | number;
+    countryCode: string;
+}
+export interface ICurrency {
+    code: string;
+    name: string;
+    symbol: string;
+    countryCode: string;
+    precision: number;
+}
+export interface ITimezone {
+    name: string;
+    offset: number;
+    offset_name: string;
+    abbreviation: string;
+    tzName: string;
+    countryCode: string;
+}
+export interface IDivision {
+    name: string;
+    iso2: string;
+    timezone: string;
+    countryCode: string;
+}
+export interface ICountry {
+    name: string;
+    iso2: string;
+    iso3: string;
+    phone_code: string;
+    division_type: string;
+    /** Emoji flag computed from iso2 */
+    flag: string;
+    /** SVG/Image URL for the country flag */
+    flag_url: string;
+    /** Default language code for the country */
+    language_code: string;
+    /** Default currency code for the country */
+    currency_code: string;
+    /** Label for tax identification number (e.g. "VAT", "SSN", "ABN") */
+    tax_id_label: string;
+    /** Placeholder for tax identification number */
+    tax_id_placeholder: string;
+    /** Label for postal/zip code (e.g. "ZIP Code", "Postcode", "PIN Code") */
+    postal_code_label: string;
+}
+export interface ILanguage {
+    code: string;
+    english_name: string;
+    native_name: string;
+}
+export interface ICountryPickerProps {
+    /** Currently selected country */
+    value?: ICountry | null;
+    /** Callback when user selects a country */
+    onChange: (country: ICountry) => void;
+    placeholder?: string;
+    /** Enable search input */
+    searchable?: boolean;
+    /** Show emoji flag next to country name */
+    showFlag?: boolean;
+    /** Show phone dial code */
+    showPhoneCode?: boolean;
+    /** Disable the picker */
+    disabled?: boolean;
+    /** Additional wrapper class */
+    className?: string;
+    /** aria-label */
+    label?: string;
+}
+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 */
+    countryIso2?: string;
+    /** Auto-select the first currency if countryIso2 is provided. Defaults to true if countryIso2 is present and value is empty. */
+    autoSelect?: boolean;
+    /** Show currency symbol alongside code */
+    showSymbol?: boolean;
+    disabled?: boolean;
+    className?: string;
+    label?: string;
+}
+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 */
+    countryIso2?: string;
+    /** Auto-select the first timezone if countryIso2 is provided. Defaults to true if countryIso2 is present and value is empty. */
+    autoSelect?: boolean;
+    disabled?: boolean;
+    className?: string;
+    label?: string;
+}
+export interface ILanguagePickerProps {
+    value?: ILanguage | null;
+    onChange: (language: ILanguage) => void;
+    placeholder?: string;
+    searchable?: boolean;
+    /** Show native language name alongside english name */
+    showNativeName?: boolean;
+    disabled?: boolean;
+    className?: string;
+    label?: string;
+}
+export interface IDivisionPickerProps {
+    /** ISO2 code of the parent country (required) */
+    countryIso2: string;
+    value?: IDivision | null;
+    onChange: (division: IDivision) => void;
+    placeholder?: string;
+    searchable?: boolean;
+    disabled?: boolean;
+    className?: string;
+    label?: string;
+}
+export interface IUsePickerReturn<T> {
+    isOpen: boolean;
+    searchQuery: string;
+    filteredItems: T[];
+    selectedItem: T | null;
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+    setSearchQuery: (query: string) => void;
+    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 IPhoneValue {
+    /** Full Country object of the selected 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 IPhoneInputProps {
+    value?: IPhoneValue | null;
+    onChange: (value: IPhoneValue) => void;
+    /** Pre-select a country by ISO2 on first render */
+    defaultCountryIso2?: string;
+    placeholder?: string;
+    showFlag?: boolean;
+    disabled?: boolean;
+    className?: string;
+    label?: string;
+}
+export interface ICountryMultiSelectProps {
+    value: ICountry[];
+    onChange: (countries: ICountry[]) => void;
+    placeholder?: string;
+    /** Maximum number of selections (undefined = unlimited) */
+    maxItems?: number;
+    showFlags?: boolean;
+    searchable?: boolean;
+    disabled?: boolean;
+    className?: string;
+    label?: string;
+}
+export interface ICurrencyMultiSelectProps {
+    value: ICurrency[];
+    onChange: (currencies: ICurrency[]) => void;
+    placeholder?: string;
+    maxItems?: number;
+    showSymbol?: boolean;
+    searchable?: boolean;
+    disabled?: boolean;
+    className?: string;
+    label?: string;
+}
+export interface IUseMultiSelectReturn<T> {
+    isOpen: boolean;
+    searchQuery: string;
+    filteredItems: T[];
+    selectedItems: T[];
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+    setSearchQuery: (query: string) => void;
+    toggleItem: (item: T) => void;
+    isSelected: (item: T) => boolean;
+    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

@@ -0,0 +1,62 @@
+import { iso2ToFlag as _iso2ToFlag } from '../data/countries';
+import { ICountry, ICurrency, IDivision, IPhoneFormat, ITimezone } from '../types';
+/**
+ * Convert ISO2 code to emoji flag
+ * Re-exported from the generated data module.
+ */
+export { _iso2ToFlag as iso2ToFlag };
+/**
+ * Returns all countries
+ */
+export declare function getAllCountries(): ICountry[];
+/**
+ * Find a country by its ISO2 code (case-insensitive)
+ */
+export declare function getCountryByIso2(iso2: string): ICountry | undefined;
+/**
+ * Find a country by its ISO3 code (case-insensitive)
+ */
+export declare function getCountryByIso3(iso3: string): ICountry | undefined;
+/**
+ * Find a country by its name (partial, case-insensitive)
+ */
+export declare function getCountryByName(name: string): ICountry | undefined;
+/**
+ * Search countries by name, iso2, iso3 or phone code
+ */
+export declare function searchCountries(query: string): ICountry[];
+/**
+ * Get all divisions for a country
+ */
+export declare function getDivisionsByCountry(iso2: string): IDivision[];
+/**
+ * Get all timezones for a country
+ */
+export declare function getTimezonesByCountry(iso2: string): ITimezone[];
+/**
+ * Get the currency for a country
+ */
+export declare function getCurrencyByCountry(iso2: string): ICurrency | undefined;
+/**
+ * Get the phone format for a country
+ */
+export declare function getPhoneFormatByCountry(iso2: string): IPhoneFormat | undefined;
+/**
+ * Get the min and max phone number lengths for a country
+ */
+export declare function getPhoneLengths(iso2: string): {
+    min?: number;
+    max?: number;
+};
+/**
+ * Get the localized Tax ID label for a country
+ */
+export declare function getTaxLabelByCountry(iso2: string): string;
+/**
+ * Get the localized Tax ID placeholder for a country
+ */
+export declare function getTaxPlaceholderByCountry(iso2: string): string;
+/**
+ * Get the localized Postal Code label for a country
+ */
+export declare function getPostalLabelByCountry(iso2: string): string;

package/dist/utils/currencies.d.ts

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

package/dist/utils/languages.d.ts

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

@@ -0,0 +1,14 @@
+import { ITimezone } from '../types';
+/**
+ * Returns all unique timezones across all countries
+ */
+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): ITimezone | undefined;
+/**
+ * Search timezones by name, abbreviation, or offset string
+ */
+export declare function searchTimezones(query: string, countryIso2?: string): ITimezone[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-country-kit-core",
-  "version": "1.2.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",
@@ -20,9 +20,9 @@
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.js"
     }
   },
   "files": [