🤖 Merge PR DefinitelyTyped#72289 MapBox SDK: extend geocode response to align with documentation by @murbanowicz

Author: murbanowicz

types/mapbox__mapbox-sdk/index.d.ts

@@ -316,15 +316,13 @@ declare module "@mapbox/mapbox-sdk/services/datasets" {
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/services/directions" {
     import * as GeoJSON from "geojson";
-    import { LngLatLike } from "mapbox-gl";
     // eslint-disable-next-line @definitelytyped/no-self-import
     import MapiClient, { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
     // eslint-disable-next-line @definitelytyped/no-self-import
     import {
         Coordinates,
         DirectionsApproach,
-        MapboxProfile,
-        MapiRequest,
+        MapiRequest
     } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
 
     export default function Directions(config: SdkConfig | MapiClient): DirectionsService;
@@ -876,7 +874,7 @@ declare module "@mapbox/mapbox-sdk/services/directions" {
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/services/geocoding-v6" {
     // eslint-disable-next-line @definitelytyped/no-self-import
-    import { Coordinates as MapiRequestCoordinates, MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
+    import { MapiRequest, Coordinates as MapiRequestCoordinates } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
     // eslint-disable-next-line @definitelytyped/no-self-import
     import MapiClient, { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
 
@@ -1122,6 +1120,31 @@ declare module "@mapbox/mapbox-sdk/services/geocoding-v6" {
          * available and applicable to a given country or area.
          */
         context: Context;
+        /**
+         * Feature id. The mapbox_id uniquely identifies a place in the Mapbox search database.
+         * Mapbox ID's are accepted in requests to the Geocoding API as a forward search, and will
+         * return the feature corresponding to that id.
+         */
+        mapbox_id: string;
+        /**
+         * Formatted string of address_number and street.
+         */
+        name: string;
+        /**
+         * The canonical or otherwise more common alias for the feature name. For example,
+         * searching for "America" will return "America" as the name, and "United States" as
+         * name_preferred.
+         */
+        name_preferred?: string;
+        /**
+         * Formatted string of result context: place region country postcode. The part of the result
+         * which comes after name.
+         */
+        place_formatted?: string;
+        /**
+         * Full formatted string of the feature, combining name_preferred and place_formatted.
+         */
+        full_address?: string;
     }
 
     interface Coordinates {
@@ -1742,7 +1765,7 @@ declare module "@mapbox/mapbox-sdk/services/optimization" {
     // eslint-disable-next-line @definitelytyped/no-self-import
     import { Waypoint } from "@mapbox/mapbox-sdk/services/directions";
     // eslint-disable-next-line @definitelytyped/no-self-import
-    import { DirectionsApproach, MapboxProfile, MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
+    import { MapboxProfile, MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
     // eslint-disable-next-line @definitelytyped/no-self-import
     import MapiClient, { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
 
@@ -2088,8 +2111,7 @@ declare module "@mapbox/mapbox-sdk/services/styles" {
 
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/services/tilequery" {
-    import * as mapboxgl from "mapbox-gl";
-    // eslint-disable-next-line @definitelytyped/no-self-import
+            // eslint-disable-next-line @definitelytyped/no-self-import
     import { Coordinates, MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
     // eslint-disable-next-line @definitelytyped/no-self-import
     import MapiClient, { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";

types/mapbox__mapbox-sdk/mapbox__mapbox-sdk-tests.ts

@@ -2,7 +2,7 @@ import mbxClient from "@mapbox/mapbox-sdk";
 import { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
 import { MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
 import { MapiResponse } from "@mapbox/mapbox-sdk/lib/classes/mapi-response";
-import Directions, { DirectionsResponse, DirectionsService } from "@mapbox/mapbox-sdk/services/directions";
+import Directions, { DirectionsService } from "@mapbox/mapbox-sdk/services/directions";
 import Geocoding, { GeocodeService } from "@mapbox/mapbox-sdk/services/geocoding";
 import GeocodingV6, { GeocodeService as GeocodeServiceV6 } from "@mapbox/mapbox-sdk/services/geocoding-v6";
 import Isochrone, { IsochroneService } from "@mapbox/mapbox-sdk/services/isochrone";
@@ -289,6 +289,9 @@ geocodeServiceV6
     .then(({ body }) => {
         body.features.forEach((feature) => {
             const shortCode = feature.properties.context.place?.short_code;
+            const placeFormatted = feature.properties.place_formatted;
+            const fullAddress = feature.properties.full_address;
+            const name_preferred = feature.properties.name_preferred;
         });
     });