add useGeocoderV6 flag that allows to use v6 endpoint instead of v5 for geocoding

Author: VladislavMedved

debug/index.js

@@ -75,6 +75,7 @@ var geocoder = new MapboxGeocoder({
   accessToken: mapboxgl.accessToken,
   trackProximity: true,
   enableGeolocation: true,
+  useGeocoderV6: true,
   localGeocoder: function(query) {
     return coordinatesGeocoder(query);
   },
@@ -85,7 +86,18 @@ var geocoder = new MapboxGeocoder({
         .then(response => response.json())
     }
   },
-  mapboxgl: mapboxgl
+  mapboxgl: mapboxgl,
+  searchType: 'structured',
+  queryCoordinates: {longitude: 40.76490756883251, latitude: -74.0437572064368},
+  address_line1: 'address_line1',
+  address_number: 'address_number',
+  street: 'street',
+  place: 'place',
+  region: 'region',
+  countries: 'US',
+  postcode: 'postcode',
+  locality: 'locality',
+  permanent: true
 });
 
 map.addControl(geocoder)

debug/mock-api.json

@@ -1,3 +1,58 @@
 [
-  {"id":"place.7673410831246050","type":"Feature","place_type":["place"],"relevance":1,"properties":{"wikidata":"Q61"},"text_en-US":"Washington","language_en-US":"en","place_name_en-US":"Washington, District of Columbia, United States of America","text":"Washington","language":"en","place_name":"SERVER: Washington, District of Columbia, United States of America","matching_place_name":"Washington, DC, United States of America","bbox":[-77.1197609567342,38.79155738,-76.909391,38.99555093],"center":[-77.0366,38.895],"geometry":{"type":"Point","coordinates":[-77.0366,38.895]},"context":[{"id":"region.14064402149979320","short_code":"US-DC","wikidata":"Q3551781","text_en-US":"District of Columbia","language_en-US":"en","text":"District of Columbia","language":"en"},{"id":"country.19678805456372290","wikidata":"Q30","short_code":"us","text_en-US":"United States of America","language_en-US":"en","text":"United States of America","language":"en"}]}
-]
+  {
+    "type": "Feature",
+    "geometry": {
+      "type": "Point",
+      "coordinates": [-97.61568, 51.084213]
+    },
+    "properties": {
+      "mapbox_id": "address.5243356057056628",
+      "feature_type": "address",
+      "name": "12 Main Street",
+      "coordinates": {
+        "longitude": -97.61568,
+        "latitude": 51.084213,
+        "accuracy": "point"
+      },
+      "place_formatted": "Fisher Branch, Manitoba R0C 0Z0, Canada",
+      "street": "Main Street",
+      "address_number": "12",
+      "match_code": {
+        "exact_match": false,
+        "house_number": "matched",
+        "street": "unmatched",
+        "postcode": "unmatched",
+        "place": "unmatched",
+        "region": "unmatched",
+        "locality": "not_applicable",
+        "country": "inferred",
+        "confidence": "low"
+      },
+      "context": {
+        "postcode": {
+          "id": "postcode.5061127719",
+          "name": "R0C 0Z0"
+        },
+        "place": {
+          "id": "place.24258599",
+          "name": "Fisher Branch",
+          "wikidata_id": "Q5454766"
+        },
+        "region": {
+          "id": "region.25639",
+          "name": "Manitoba",
+          "wikidata_id": "Q1948",
+          "region_code": "MB",
+          "region_code_full": "CA-MB"
+        },
+        "country": {
+          "id": "country.8743",
+          "name": "Canada",
+          "wikidata_id": "Q16",
+          "country_code": "CA",
+          "country_code_alpha_3": "CAN"
+        }
+      }
+    }
+  }
+]

lib/geolocation-v6.js

@@ -12,6 +12,7 @@ var localization = require('./localization');
 var subtag = require('subtag');
 var Geolocation = require('./geolocation');
 var utils = require('./utils');
+var MapboxGeocoderV6 = require('./geolocation-v6.js');
 
 
 const GEOCODE_REQUEST_TYPE = {
@@ -75,6 +76,7 @@ function getFooterNode() {
  * @param {Boolean} [options.routing=false] Specify whether to request additional metadata about the recommended navigation destination corresponding to the feature or not. Only applicable for address features.
  * @param {String} [options.worldview="us"] Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups.
  * @param {Boolean} [options.enableGeolocation=false] If `true` enable user geolocation feature.
+ * @param {Boolean} [options.useGeocoderV6=false] If `true` use v6 endpoint instead of v5.
  * @param {('address'|'street'|'place'|'country')} [options.addressAccuracy="street"] The accuracy for the geolocation feature with which we define the address line to fill. The browser API returns the user's position with accuracy, and sometimes we can get the neighbor's address. To prevent receiving an incorrect address, you can reduce the accuracy of the definition.
  * @example
  * var geocoder = new MapboxGeocoder({ accessToken: mapboxgl.accessToken });
@@ -90,6 +92,7 @@ function MapboxGeocoder(options) {
   this.fresh = true;
   this.lastSelected = null;
   this.geolocation = new Geolocation();
+  return this.options.useGeocoderV6 ? new MapboxGeocoderV6(options) : this;
 }
 
 MapboxGeocoder.prototype = {

lib/index.js

@@ -34,12 +34,18 @@ function transformFeatureToGeolocationText(feature, accuracy) {
     return acc + addrInfo[name];
   }, '');
 }
+
+const isV5Feature = (feature) => "id" in feature;
+
 /**
  * This function transforms the feature from reverse geocoding to AddressInfo object
  * @param {object} feature 
  * @returns {object}
  */
 function getAddressInfo(feature) {
+  if(!isV5Feature(feature)) {
+    return getV6AddressInfo(feature);
+  }
   const houseNumber = feature.address || '';
   const street = feature.text || '';
   const placeName = feature.place_name || '';
@@ -60,6 +66,34 @@ function getAddressInfo(feature) {
   return addrInfo;
 }
 
+/**
+ * This function transforms the v6 feature from reverse geocoding to AddressInfo object
+ * @param {object} feature 
+ * @returns {object}
+ */
+function getV6AddressInfo(feature) {
+  const houseNumber = feature.address_number || "";
+  const street = feature.street || "";
+  const placeName = feature.place_formatted || "";
+  const address = placeName.split(",")[0];
+
+  const addrInfo = {
+    address: address,
+    houseNumber: houseNumber,
+    street: street,
+    placeName: placeName,
+  };
+
+  for (const contextProp in feature.context) {
+    if (contextProp) {
+      const layer = contextProp.id.split(".")[0];
+      addrInfo[layer] = contextProp.text;
+    }
+  }
+
+  return addrInfo;
+}
+
 const REVERSE_GEOCODE_COORD_RGX = /^[ ]*(-?\d{1,3}(\.\d{0,256})?)[, ]+(-?\d{1,3}(\.\d{0,256})?)[ ]*$/;
 
 module.exports = {