node-geocoder/dist/lib/geocoder/opencagegeocoder.js

Node Geocoder, node geocoding library, supports google maps, mapquest, open street map, tom tom, promise

"use strict";
var util = require('util'), AbstractGeocoder = require('./abstractgeocoder');
// http://geocoder.opencagedata.com/api.html#confidence
var ConfidenceInKM = {
    10: 0.25,
    9: 0.5,
    8: 1,
    7: 5,
    6: 7.5,
    5: 10,
    4: 15,
    3: 20,
    2: 25,
    1: Number.POSITIVE_INFINITY,
    0: Number.NaN
};
/**
 * Constructor
 */
var OpenCageGeocoder = function OpenCageGeocoder(httpAdapter, apiKey, options) {
    this.options = ['language'];
    OpenCageGeocoder.super_.call(this, httpAdapter, options);
    if (!apiKey || apiKey == 'undefined') {
        throw new Error(this.constructor.name + ' needs an apiKey');
    }
    this.apiKey = apiKey;
    this._endpoint = 'http://api.opencagedata.com/geocode/v1/json';
    this._ConfidenceInKM = ConfidenceInKM; // In case we need to support v1/v2 and this changes
};
util.inherits(OpenCageGeocoder, AbstractGeocoder);
/**
 * Geocode
 * @param <string>   value    Value to geocode (Address)
 * @param <function> callback Callback method
 */
OpenCageGeocoder.prototype._geocode = function (value, callback) {
    var _this = this;
    var params = this._getCommonParams();
    if (value.address) {
        if (value.bounds) {
            if (Array.isArray(value.bounds)) {
                params.bounds = value.bounds.join(',');
            }
            else {
                params.bounds = value.bounds;
            }
        }
        if (value.countryCode) {
            params.countrycode = value.countryCode;
        }
        if (value.limit) {
            params.limit = value.limit;
        }
        if (value.minConfidence) {
            params.min_confidence = value.minConfidence;
        }
        if (value.language) {
            params.language = value.language;
        }
        params.q = value.address;
    }
    else {
        params.q = value;
    }
    this.httpAdapter.get(this._endpoint, params, function (err, result) {
        if (err) {
            return callback(err);
        }
        else {
            var results = [];
            if (result && result.results instanceof Array) {
                for (var i = 0; i < result.results.length; i++) {
                    results.push(_this._formatResult(result.results[i]));
                }
            }
            results.raw = result;
            callback(false, results);
        }
    });
};
OpenCageGeocoder.prototype._formatResult = function (result) {
    var confidence = result.confidence || 0;
    return {
        latitude: result.geometry.lat,
        longitude: result.geometry.lng,
        country: result.components.country,
        city: result.components.city,
        state: result.components.state,
        zipcode: result.components.postcode,
        streetName: result.components.road,
        streetNumber: result.components.house_number,
        countryCode: result.components.country_code,
        county: result.components.county,
        extra: {
            confidence: confidence,
            confidenceKM: this._ConfidenceInKM[result.confidence] || Number.NaN
        }
    };
};
/**
 * Reverse geocoding
 * @param {lat:<number>,lon:<number>}  lat: Latitude, lon: Longitude
 * @param <function> callback Callback method
 */
OpenCageGeocoder.prototype._reverse = function (query, callback) {
    var lat = query.lat;
    var lng = query.lon;
    var _this = this;
    var params = this._getCommonParams();
    params.q = lat + ' ' + lng;
    this.httpAdapter.get(this._endpoint, params, function (err, result) {
        if (err) {
            callback(err);
        }
        else {
            var results = [];
            if (result && result.results instanceof Array) {
                for (var i = 0; i < result.results.length; i++) {
                    results.push(_this._formatResult(result.results[i]));
                }
            }
            results.raw = result;
            callback(false, results);
        }
    });
};
/**
 * Prepare common params
 *
 * @return <Object> common params
 */
OpenCageGeocoder.prototype._getCommonParams = function () {
    var params = {};
    params.key = this.apiKey;
    if (this.options.language) {
        params.language = this.options.language;
    }
    return params;
};
module.exports = OpenCageGeocoder;