libphonenumber-geo-carrier/lib/index.js

This library includes the geocoding, carrier mapping and timezone mapping functionalities that are available in some of googles libphonenumber libraries but not in libphonenumber-js (a port of libphonenumber).

'use strict';

var fs = require('fs');
var util = require('util');
var bson = require('bson');
var path = require('path');

const access = util.promisify(fs.access);
const readFile = util.promisify(fs.readFile);
/**
 * Maps the dataPath and prefix to geocode, carrier, timezones or null if this info could not be extracted
 *
 * **Note:** Timezones are returned as single string joined with `&`
 *
 * @param dataPath Path of the metadata bson file to use
 * @param nationalNumber The national (significant) number without whitespaces e.g. `2133734253`
 */
const getCode = async (dataPath, nationalNumber) => {
    try {
        await access(dataPath);
        const bData = await readFile(dataPath);
        const data = bson.deserialize(bData);
        let prefix = nationalNumber;
        // Find the longest match
        while (prefix.length > 0) {
            const description = data[prefix];
            if (description) {
                return description;
            }
            // Remove a character from the end
            prefix = prefix.substring(0, prefix.length - 1);
        }
    }
    catch (err) {
        // console.log('Could not parse bson', err)
    }
    return null;
};
/**
 * Provides geographical information related to the phone number
 *
 * @param phonenumber The phone number
 * @param locale The preferred locale to use (falls back to `en` if there are no localized carrier infos for the given locale)
 */
const geocoder = async (phonenumber, locale = 'en') => {
    const nationalNumber = phonenumber === null || phonenumber === void 0 ? void 0 : phonenumber.nationalNumber.toString();
    const countryCallingCode = phonenumber === null || phonenumber === void 0 ? void 0 : phonenumber.countryCallingCode.toString();
    if (!nationalNumber || !countryCallingCode) {
        return null;
    }
    let dataPath = path.join(__dirname, '../resources/geocodes/', locale, `${countryCallingCode}.bson`);
    // const code = await getCode(dataPath, prefix)
    const code = await getCode(dataPath, nationalNumber);
    if (code) {
        return code;
    }
    if (locale !== 'en') {
        // Try fallback to english
        dataPath = path.join(__dirname, '../resources/geocodes/', 'en', `${countryCallingCode}.bson`);
        // return await getCode(dataPath, prefix)
        return await getCode(dataPath, nationalNumber);
    }
    return null;
};
/**
 * Maps the phone number to the original carrier
 *
 * **Note:** This method cannot provide data about the current carrier of the phone number,
 * only the original carrier who is assigned to the corresponding range.
 * @see https://github.com/google/libphonenumber#mapping-phone-numbers-to-original-carriers
 *
 * @param phonenumber The phone number
 * @param locale The preferred locale to use (falls back to `en` if there are no localized carrier infos for the given locale)
 */
const carrier = async (phonenumber, locale = 'en') => {
    if (!phonenumber) {
        return null;
    }
    const nationalNumber = phonenumber === null || phonenumber === void 0 ? void 0 : phonenumber.nationalNumber.toString();
    const countryCallingCode = phonenumber === null || phonenumber === void 0 ? void 0 : phonenumber.countryCallingCode.toString();
    if (!nationalNumber || !countryCallingCode) {
        return null;
    }
    let dataPath = path.join(__dirname, '../resources/carrier/', locale, `${countryCallingCode}.bson`);
    // const code = await getCode(dataPath, prefix)
    const code = await getCode(dataPath, nationalNumber);
    if (code) {
        return code;
    }
    if (locale !== 'en') {
        // Try fallback to english
        dataPath = path.join(__dirname, '../resources/carrier/', 'en', `${countryCallingCode}.bson`);
        // return await getCode(dataPath, prefix)
        return await getCode(dataPath, nationalNumber);
    }
    return null;
};
/**
 * Provides all timezones related to the phone number
 * @param phonenumber The phone number
 */
const timezones = async (phonenumber) => {
    let nr = phonenumber === null || phonenumber === void 0 ? void 0 : phonenumber.number.toString();
    if (!nr) {
        return null;
    }
    nr = nr.replace(/^\+/, '');
    let dataPath = path.join(__dirname, '../resources/timezones.bson');
    const zones = await getCode(dataPath, nr);
    if (typeof zones === 'string') {
        return zones.split('&');
    }
    return null;
};

exports.carrier = carrier;
exports.geocoder = geocoder;
exports.timezones = timezones;