updated geocoding API (#41)

maptiler · Apr 18, 2024 · f5b81da · f5b81da
1 parent 305cf83
commit f5b81da
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## DEVEL
 ### New Features
+- Added `matching_text` and `matching_place_name` properties to geocoding feature response
+- Added `road` to geocoding `types`
+
 ### Bug Fixes
 ### Others
 

diff --git a/src/services/geocoding.ts b/src/services/geocoding.ts
@@ -52,6 +52,7 @@ export type CommonForwardAndReverseGeocodingOptions =
       | "place"
       | "postal_code"
       | "address"
+      | "road"
       | "poi"
     )[];
 
@@ -220,6 +221,18 @@ export type GeocodingFeature = Feature<Geometry, FeatureProperties> &
      * You can use the relevance property to remove results that don't fully match the query.
      */
     relevance: number;
+
+    /**
+     * A string analogous to the `text` field that more closely matches the query than results in the specified language.
+     * For example, querying _Praha, Czechia_ with language set to English (`en`) might return a feature with the `text` _Prague_ and the `matching_text` _Praha_.
+     */
+    matching_text?: string;
+
+    /**
+     * A string analogous to the `place_name` field that more closely matches the query than results in the specified language.
+     * For example, querying _Praha, Czechia_ with language set to English (`en`) might return a feature with the `place_name` _Prague, Czechia_ and a `matching_place_name` of _Praha, Czechia_.
+     */
+    matching_place_name?: string;
   };
 
 export type GeocodingSearchResult = {