@panoramax/web-viewer 4.0.2-develop-9d664bb8 → 4.0.2-develop-9b499e28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@panoramax/web-viewer",
-  "version": "4.0.2-develop-9d664bb8",
+  "version": "4.0.2-develop-9b499e28",
   "description": "Panoramax web viewer for geolocated pictures",
   "main": "build/index.js",
   "author": "Panoramax team",

package/src/utils/geocoder.js

@@ -3,6 +3,20 @@ import maplibregl from "!maplibre-gl";
 
 import { NominatimBaseUrl, AdresseDataGouvBaseURL } from "./services";
 
+const PLACETYPE_ZOOM =  {
+	"house": 20,
+	"housenumber": 20,
+	"street": 18,
+	"locality": 15,
+	"district": 13,
+	"municipality": 12,
+	"city": 12,
+	"county": 8,
+	"region": 7,
+	"state": 7,
+	"country": 5
+};
+
 /**
  * Transforms a set of parameters into an URL-ready string
  * It also removes null/undefined values
@@ -20,42 +34,6 @@ function geocoderParamsToURLString(params) {
 	return new URLSearchParams(p).toString();
 }
 
-/**
- * Transforms Nominatim search result into a nice-to-display address.
- * @param {object} props The Nominatim API feature properties
- * @returns {string} The clean-up string for display
- * @private
- */
-function nominatimAddressToPlaceName(props) {
-	// API format @ https://nominatim.org/release-docs/develop/api/Output/#addressdetails
-
-	const nameKind = [
-		"house_name", "emergency", "historic", "military", "natural", "landuse", "place", "railway", "man_made",
-		"aerialway", "boundary", "amenity", "aeroway", "club", "craft", "leisure", "office",
-		"mountain_pass", "shop", "tourism", "bridge", "tunnel", "waterway", "park"
-	].find(pn => props?.address?.[pn]);
-
-	const localityKind = [
-		"hamlet", "croft", "isolated_dwelling",
-		"farm", "farmyard", "industrial", "commercial", "retail", "city_block", "residential",
-		"neighbourhood", "allotments", "quarter",
-	].find(pn => props?.address?.[pn]);
-
-	const stprops = {
-		type: props?.addresstype || props?.type,
-		name: (props?.name?.length > 0 ? props.name : null) || (nameKind ? props.address[nameKind] : undefined),
-		housenumber: props?.address?.house_number,
-		street: props?.address?.road,
-		locality: localityKind ? props.address[localityKind] : undefined,
-		city: props?.address?.village || props?.address?.town || props?.address?.city || props?.address?.municipality,
-		county: props?.address?.county,
-		state: props?.address?.state,
-		country: props?.address?.country,
-	};
-
-	return geocodeJsonToPlaceName(stprops);
-}
-
 /**
  * Nominatim (OSM) geocoder, ready to use for our Map
  * @private
@@ -69,18 +47,19 @@ export function forwardGeocodingNominatim(config) {
 		viewbox: config.bbox,
 	};
 
-	return fetch(`${NominatimBaseUrl()}/search?${geocoderParamsToURLString(params)}&format=geojson&polygon_geojson=1&addressdetails=1`)
+	return fetch(`${NominatimBaseUrl()}/search?${geocoderParamsToURLString(params)}&format=geocodejson&addressdetails=1`)
 		.then(res => res.json())
 		.then(res => {
 			const finalRes = { features: [] };
 			const listedNames = [];
-			res.features.forEach(f => {
-				const plname = nominatimAddressToPlaceName(f.properties) || f.properties.display_name;
+			(res.features || []).forEach(f => {
+				const plname = geocodeJsonToPlaceName(f.properties?.geocoding) || f.properties?.geocoding?.label;
 				if(!listedNames.includes(plname)) {
 					finalRes.features.push({
 						place_type: ["place"],
 						place_name: plname,
-						bounds: new maplibregl.LngLatBounds(f.bbox),
+						center: new maplibregl.LngLat(...f.geometry.coordinates),
+						zoom: PLACETYPE_ZOOM[f.properties?.geocoding?.type],
 					});
 					listedNames.push(plname);
 				}
@@ -90,9 +69,9 @@ export function forwardGeocodingNominatim(config) {
 }
 
 export function reverseGeocodingNominatim(lat, lon) {
-	return fetch(`${NominatimBaseUrl()}/reverse?lat=${lat}&lon=${lon}&zoom=18&format=jsonv2`)
+	return fetch(`${NominatimBaseUrl()}/reverse?lat=${lat}&lon=${lon}&zoom=18&format=geocodejson`)
 		.then(res => res.json())
-		.then(res => nominatimAddressToPlaceName(res?.address));
+		.then(res => geocodeJsonToPlaceName(res?.features?.shift()?.properties?.geocoding));
 }
 
 /**
@@ -164,6 +143,7 @@ function geocodeJsonToPlaceName(props) {
 		p3.push(props.country);
 		break;
 	case "street":
+	case "road":
 	default:
 		p2.push(props.street);
 		p2.push(props.locality);
@@ -204,20 +184,6 @@ export function forwardGeocodingStandard(config, endpoint) {
 		params.lon = lon;
 	}
 
-	const placeTypeToZoom =  {
-		"house": 20,
-		"housenumber": 20,
-		"street": 18,
-		"locality": 15,
-		"district": 13,
-		"municipality": 12,
-		"city": 12,
-		"county": 8,
-		"region": 7,
-		"state": 7,
-		"country": 5
-	};
-	
 	return fetch(`${endpoint}/?${geocoderParamsToURLString(params)}`)
 		.then(res => res.json())
 		.then(res => {
@@ -230,7 +196,7 @@ export function forwardGeocodingStandard(config, endpoint) {
 						place_type: ["place"],
 						place_name: plname,
 						center: new maplibregl.LngLat(...f.geometry.coordinates),
-						zoom: placeTypeToZoom[f.properties.type],
+						zoom: PLACETYPE_ZOOM[f.properties.type],
 					});
 					listedNames.push(plname);
 				}

package/tests/data/Map_geocoder_nominatim.json

@@ -1,56 +1,41 @@
 {
   "type": "FeatureCollection",
-  "licence": "Data © OpenStreetMap contributors, ODbL 1.0. https://osm.org/copyright",
+  "geocoding": {
+    "version": "0.1.0",
+    "attribution": "Data © OpenStreetMap contributors, ODbL 1.0. http://osm.org/copyright",
+    "licence": "ODbL",
+    "query": "paris"
+  },
   "features": [
     {
       "type": "Feature",
       "properties": {
-        "place_id": 297417241,
-        "osm_type": "relation",
-        "osm_id": 7444,
-        "display_name": "Paris, Île-de-France, France métropolitaine, France",
-        "place_rank": 15,
-        "category": "boundary",
-        "type": "administrative",
-        "importance": 0.9317101715588673,
-        "icon": "https://nominatim.openstreetmap.org/ui/mapicons/poi_boundary_administrative.p.20.png",
-        "address": {
-          "suburb": "Paris",
-          "city_district": "Paris",
-          "city": "Paris",
-          "ISO3166-2-lvl6": "FR-75",
+        "geocoding": {
+          "place_id": 88066702,
+          "osm_type": "relation",
+          "osm_id": 71525,
+          "osm_key": "boundary",
+          "osm_value": "administrative",
+          "type": "city",
+          "label": "Paris, Île-de-France, France métropolitaine, France",
+          "name": "Paris",
           "state": "Île-de-France",
-          "ISO3166-2-lvl4": "FR-IDF",
-          "region": "France métropolitaine",
           "country": "France",
-          "country_code": "fr"
+          "country_code": "fr",
+          "admin": {
+            "level6": "Paris",
+            "level4": "Île-de-France",
+            "level3": "France métropolitaine"
+          }
         }
       },
-      "bbox": [
-        2.224122,
-        48.8155755,
-        2.4697602,
-        48.902156
-      ],
       "geometry": {
-        "type": "Polygon",
+        "type": "Point",
         "coordinates": [
-          [
-            [
-              2.224122,
-              48.854199
-            ],
-            [
-              2.224125,
-              48.85402
-            ],
-            [
-              2.224125,
-              48.853869
-            ]
-          ]
+          2.3483915,
+          48.8534951
         ]
       }
     }
   ]
-}
+}

package/tests/utils/__snapshots__/geocoder.test.js.snap

@@ -22,20 +22,15 @@ exports[`forwardGeocodingNominatim works 1`] = `
 Object {
   "features": Array [
     Object {
-      "bounds": Object {
-        "ne": Object {
-          "lat": 47.8,
-          "lng": -1.7,
-        },
-        "sw": Object {
-          "lat": 47.8,
-          "lng": -1.7,
-        },
+      "center": Object {
+        "lat": 47.8,
+        "lng": -1.7,
       },
-      "place_name": "Paris",
+      "place_name": "Paris, Île-de-France",
       "place_type": Array [
         "place",
       ],
+      "zoom": 12,
     },
   ],
 }

package/tests/utils/geocoder.test.js

@@ -13,7 +13,7 @@ describe("forwardGeocodingNominatim", () => {
 		const cfg = { query: "bla", limit: 5, bbox: "17.7,-45.2,17.8,-45.1" };
 
 		return geocoder.forwardGeocodingNominatim(cfg).then(res => {
-			expect(global.fetch.mock.calls).toEqual([["https://nominatim.openstreetmap.org/search?q=bla&limit=5&viewbox=17.7%2C-45.2%2C17.8%2C-45.1&format=geojson&polygon_geojson=1&addressdetails=1"]]);
+			expect(global.fetch.mock.calls).toEqual([["https://nominatim.openstreetmap.org/search?q=bla&limit=5&viewbox=17.7%2C-45.2%2C17.8%2C-45.1&format=geocodejson&addressdetails=1"]]);
 			expect(res).toMatchSnapshot();
 		});
 	});