base-vue-phone-input/src/helpers/use-libphonenumber.ts

customizable vue3 phone input

import {
    AsYouType,
    type CountryCode,
    type Examples,
    getCountries,
    getCountryCallingCode,
    getExampleNumber,
    isSupportedCountry,
    parsePhoneNumberFromString,
} from 'libphonenumber-js'
import type { Results } from './types'

function isCountryAvailable(locale: string) {
    try {
        const response = isSupportedCountry(locale)

        if (!response) {
            console.error(` The code country "${locale}" is not available`)

            return false
        }

        return response
    } catch (error) {
        console.error(` ${error}`)
        return false
    }
}

function getPhoneNumberResults({
    phoneNumber,
    countryCode,
}: {
    phoneNumber?: string
    countryCode?: CountryCode
}): Results {
    try {
        if (!phoneNumber) {
            return {
                isValid: false,
                countryCode,
            }
        }

        const parsedNumber = parsePhoneNumberFromString(
            phoneNumber,
            countryCode
        )

        return {
            countryCode: parsedNumber?.country ?? countryCode,
            isValid: parsedNumber?.isValid() ?? false,
            isPossible: parsedNumber?.isPossible(),
            countryCallingCode: parsedNumber?.countryCallingCode,
            nationalNumber: parsedNumber?.nationalNumber,
            type: parsedNumber?.getType(),
            formatInternational: parsedNumber?.formatInternational(),
            formatNational: parsedNumber?.formatNational(),
            uri: parsedNumber?.getURI(),
            e164: parsedNumber?.format('E.164'),
            rfc3966: parsedNumber?.format('RFC3966'),
            phoneNumber,
        }
    } catch (error) {
        throw new Error(`(getResultsFromPhoneNumber) ${error}`)
    }
}

function getAsYouTypeFormat(
    countryCode?: CountryCode,
    phoneNumber?: string
): string {
    try {
        if (!phoneNumber) {
            return ''
        }

        return new AsYouType(countryCode).input(phoneNumber)
    } catch (error) {
        throw new Error(`(getAsYouTypeFormat) ${error}`)
    }
}

async function getPhoneNumberExamplesFile() {
    const { default: data } = await import(
        'libphonenumber-js/examples.mobile.json'
    )

    return data
}

function getPhoneNumberExample(examples: Examples, countryCode?: CountryCode) {
    try {
        if (!examples) {
            return
        }

        return countryCode
            ? getExampleNumber(countryCode, examples)?.formatNational()
            : undefined
    } catch (error) {
        console.error(` ${error}`)
    }
}

export function useLibphonenumber() {
    function isSameCountryCallingCode(
        countryCode: CountryCode,
        countryCode2: CountryCode
    ) {
        return (
            getCountryCallingCode(countryCode) ===
            getCountryCallingCode(countryCode2)
        )
    }

    return {
        getAsYouTypeFormat,
        getPhoneNumberResults,
        getPhoneNumberExamplesFile,
        getPhoneNumberExample,
        isSameCountryCallingCode,
        isCountryAvailable,
        getCountries,
        getCountryCallingCode,
    }
}