feat(ban): add country to BAN's parsed response

p-j · Feb 10, 2022 · 56a3d7d · 56a3d7d
1 parent 123a202
commit 56a3d7d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/.changeset/quick-impalas-cover.md b/.changeset/quick-impalas-cover.md
@@ -0,0 +1,5 @@
+---
+'@p-j/geocodejson-ban': minor
+---
+
+Add `geocoding.country` to BAN's parsed response
diff --git a/packages/geocodejson-ban/src/geocodejson-ban.test.ts b/packages/geocodejson-ban/src/geocodejson-ban.test.ts
@@ -42,6 +42,7 @@ describe('@p-j/geocodejson-ban', () => {
                 score: 0.7592313152804641,
                 street: 'Rue du Général Leclerc',
                 type: 'housenumber',
+                country: 'France',
                 x: 635728.07,
                 y: 6855842.44,
               },
@@ -80,6 +81,7 @@ describe('@p-j/geocodejson-ban', () => {
               label: 'Place de la République 75011 Paris',
               name: 'Place de la République',
               postcode: '75011',
+              country: 'France',
               score: 0.9670254545454545,
               type: 'street',
               x: 653452.35,
@@ -120,6 +122,7 @@ describe('@p-j/geocodejson-ban', () => {
               name: 'Paris',
               population: 2190327,
               postcode: '75001',
+              country: 'France',
               score: 0.9704590909090908,
               type: 'municipality',
               x: 652089.7,
@@ -158,6 +161,7 @@ describe('@p-j/geocodejson-ban', () => {
               label: 'Pré Rura 05240 La Salle-les-Alpes',
               name: 'Pré Rura',
               postcode: '05240',
+              country: 'France',
               score: 0.9387145454545454,
               type: 'locality',
               x: 981275.7,

diff --git a/packages/geocodejson-ban/src/geocodejson-ban.ts b/packages/geocodejson-ban/src/geocodejson-ban.ts
@@ -84,6 +84,7 @@ export function parseResult(result: BANGeocodeResponse['features'][number]): Geo
     properties: {
       geocoding: {
         ...properties,
+        country: 'France', // BAN covers France only and this field isn't returned by the original response
         confidence: properties.score,
         geohash: geohash.encode(result.geometry.coordinates[1], result.geometry.coordinates[0]),
       },