release-3.4.0

IGNF · Mar 18, 2024 · c897caa · c897caa
2 parents 69817b9 + e23cbe9
commit c897caa
Show file tree

Hide file tree

Showing 46 changed files with 415 additions and 508 deletions.
diff --git a/DRAFT_CHANGELOG.md b/DRAFT_CHANGELOG.md
@@ -1,24 +1,35 @@
-# Bibliothèque d'accès aux services Géoportail, version 3.3.4
+# Bibliothèque d'accès aux services Géoplateforme, version 3.4.0
 
-**29/08/2023 : 3.3.4**
+**19/03/2024 : 3.4.0**
 
 > release of geoportal access library
 
 ## Summary
 
-Correction de la récupération automatique du paramètre style pour les couches géoportail de type WMS Vecteur
+Seconde release adaptative à la Géoplateforme : la bibliothèque d'accès aux services Geoportail devient la bibliothèque d'accès aux services Géoplateforme. 
+L'ensemble des services de calcul Géoplateforme sont interrogeables par cette release 3.4.0.
+
 
 ## Changelog
 
 * [Added]
 
 * [Changed]
 
+    - La bibliothèque d'accès utilise désormais les services d'isochrone et d'itinéraire de la Géoplateforme (7cd2f77e964999cc5dc6f0c619b7b8488349d648)
+    - La bibliothèque d'accès utilise désormais le service d'altimétrie de la Géoplateforme (343ac9b)
+    - La bibliothèque d'accès utilise désormais le service de Geocodage(direct/inverse/autocomplétion) de la Géoplateforme (89f3360)
+    - Le paramètre apiKey devient facultatif pour l'appel à la fonction getConfig (2a2913b359e5f49a12a44ab4d713cbffef9552a7)
+    - Aucune apiKey n'est necessaire pour l'appel aux services de calcul (886ceb13ffe2dbf2ffeec460d008ec49faec0fa8)
+    - Mise à jour des exemples pour les adapter à la nouvelle interface Géoplateforme (965c4c93b506016331f2c57c24ea2eb0300582ac)
+    - Mise à jour de la documentation et des README (e08b23591f37ae70b5f490406c7c43251d8057eb)
+
 * [Removed]
 
 * [Fixed]
 
-    - Récupération du string vide des styles WMS vecteur pour les couches Géoportail
+    - Correction du filtrage par territoire sur l'autocompletion (f90a65eac80ea0640a81212547957154ed84288f)
+    - Correction du logger en mode verbose en production (86386a03b8e39021e6c2aab79a10b0d44d1dab3b)
 
 * [Deprecated]
 

diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
-# Bibliothèque d'accès aux ressources du Géoportail
+# Bibliothèque d'accès aux services Géoplateforme
 
 [![Build](https://github.com/IGNF/geoportal-access-lib/actions/workflows/build.yml/badge.svg)](https://github.com/IGNF/geoportal-access-lib/actions/workflows/build.yml)
 [![GitHub release](https://img.shields.io/github/release/IGNF/geoportal-access-lib.svg)](https://github.com/IGNF/geoportal-access-lib)
 [![DeepScan grade](https://deepscan.io/api/teams/12425/projects/15468/branches/309615/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=12425&pid=15468&bid=309615)
 
 <a name="readme-top"></a>
 
-La bibliothèque d’accès aux ressources de la plateforme Géoportail est une bibliothèque de fonctions javascript permettant d'accéder aux ressources délivrées par les services web du Géoportail.
+La bibliothèque d’accès aux services Géoplateforme est une bibliothèque de fonctions javascript permettant d'accéder aux ressources délivrées par les services web de la Géoplateforme.
 
-Elle permet plus particulièrement d'effectuer les opérations suivantes utilisant les données de l'IGN :
+Elle permet plus particulièrement d'effectuer les opérations suivantes :
 
 * [Géocoder des adresses, toponymes et parcelles cadastrales](#geocode)
 
@@ -78,7 +78,6 @@ Par défaut, les services sont intérrogés en HTTP. On a la possibilité de for
 var Gp = require("chemin/vers/GpServices.js");
 
 Gp.Services.geocode({
-    apiKey : "...",
     ssl : true,
     location : "...",
     onSuccess : function (result) {
@@ -129,8 +128,6 @@ Le chargement de la bibliothèque d'accès vous donne accès au namespace [Gp.Se
 
 La fonction [Gp.Services.geocode](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~geocode) permet d'utiliser le service de géocodage de la plateforme Géoportail pour obtenir la position d'un toponyme, d'une adresse ou d'une parcelle cadastrale. Elle prend en paramètres :
 
-* une (ou des) **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources de recherche OpenLS du Géoportail.
-
 * le **localisant** dont on veut obtenir les coordonnées ;
 
 * le **type de localisant** : adresse ("StreetAddress"), toponyme ("PositionOfInterest") ou parcelle cadastrale ("CadastralParcel"). Choix multiple possible. Par défaut les adresses seront utilisées.
@@ -142,7 +139,6 @@ La fonction [Gp.Services.geocode](http://ignf.github.io/geoportal-access-lib/lat
 
 ``` javascript
 Gp.Services.geocode({
-    apiKey : "calcul", // clef d'accès à la plateforme
     location : "tour eiffel",            // localisant à géocoder
     filterOptions : {
         type : ["PositionOfInterest"]    // type de localisant
@@ -163,9 +159,7 @@ Gp.Services.geocode({
 
 ### Obtenir des suggestions d'adresses ou de toponymes à partir de textes incomplets
 
-La fonction [Gp.Services.autoComplete](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~autoComplete) permet d'utiliser le service d'autocomplétion de la plateforme Géoportail pour obtenir des suggestions de loclalisants (toponyme ou adresse) à partir d'un texte incomplet. Elle prend en paramètres :
-
-* une (ou des) **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources de recherche OpenLS du Géoportail.
+La fonction [Gp.Services.autoComplete](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~autoComplete) permet d'utiliser le service d'autocomplétion de la Géoplateforme pour obtenir des suggestions de loclalisants (toponyme ou adresse) à partir d'un texte incomplet. Elle prend en paramètres :
 
 * le **texte** pour lequel on souhaite obtenir des suggestions
 
@@ -178,7 +172,6 @@ La fonction [Gp.Services.autoComplete](http://ignf.github.io/geoportal-access-li
 
 ``` javascript
 Gp.Services.autoComplete({
-    apiKey : "calcul", // clef d'accès à la plateforme
     text : "23 rue des et",              // texte à compléter
     filterOptions : {
         type : ["StreetAddress"]         // type de texte
@@ -201,8 +194,6 @@ Gp.Services.autoComplete({
 
 La fonction [Gp.Services.reverseGeocode](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~reverseGeocode) permet d'utiliser le service de géocodage inverse de la plateforme Géoportail pour trouver des toponymes, adresses ou parcelles cadastrales proches d'une position donnée. Elle prend en paramètres :
 
-* une (ou des) **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources de recherche OpenLS du Géoportail.
-
 * une **position** donnée
 
 * le **type de localisant** : adresse ("StreetAddress"), toponyme ("PositionOfInterest") ou parcelle cadastrale ("CadastralParcel"). Choix multiple possible. Par défaut les adresses seront utilisées.
@@ -214,7 +205,6 @@ La fonction [Gp.Services.reverseGeocode](http://ignf.github.io/geoportal-access-
 
 ``` javascript
 Gp.Services.reverseGeocode({
-    apiKey : "calcul", // clef d'accès à la plateforme
     position : {                         // position de recherche
       x: 2.29,
       y: 48.85
@@ -240,8 +230,6 @@ Gp.Services.reverseGeocode({
 
 La fonction [Gp.Services.getAltitude()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~getAltitude) permet d'utiliser le service d'altimétrie de la plateforme Géoportail pour obtenir les altitudes de une ou plusieurs positions données ou calculer un profil altimétrique le long d'une liste de positions. Elle prend en paramètres :
 
-* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources altimétriques du Géoportail.
-
 * une **liste de positions** données
 
 * un éventuel paramètre (sampling) indiquant le **nombre de points intermédiaires** à utiliser dans le cas du calcul d'un profil altimétrique.
@@ -253,7 +241,6 @@ La fonction [Gp.Services.getAltitude()](http://ignf.github.io/geoportal-access-l
 
 ``` javascript
 Gp.Services.getAltitude({
-    apiKey : "altimetrie", // clef d'accès à la plateforme
     positions : [                        // positions pour le calcul alti
         { lon: 2.29, lat: 48.85 },      
         { lon: 2.3, lat: 48.9 },
@@ -277,27 +264,27 @@ Gp.Services.getAltitude({
 
 La fonction [Gp.Services.route()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~route) permet d'utiliser le service de calcul d'itinéraires de la plateforme Géoportail. Elle prend en paramètres :
 
-* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources utilisés par le calcul d'itinéraire du Géoportail : graphe routier ou piéton.
-
 * des **points de départ, d'arrivée** et éventuellement **intermédiaires**.
 
 * le **graphe** utilisé pour le calcul correspondant au profil de véhicule (piéton ou routier)
 
+* la **ressource** utilisée pour le calcul d'itinéraire (bdtopo-osrm ou bdtopo-pgr)
+
 * d'autres paramètres éventuels à passer au service...
 
 * la **fonction de traitement des résultats** qui sera appelée lorsqu'ils seront reçus. Cette fonction prend en paramètres un objet de type : [Gp.Services.RouteResponse](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/Gp.Services.RouteResponse.html).
 
 
 ``` javascript
 Gp.Services.route({
-    apiKey : "carte", // clef d'accès à la plateforme
     startPoint : { x: 2, y: 45},       // point de départ
     viaPoints : [                        // points intermédiaires
         { x: 3, y: 46 },      
         { x: 3.5, y: 46 }
     ],
     endPoint : { x: 4, y: 47},          // point d'arrivée
     graph : "Voiture",                 // grapĥe utilisé
+    resource : "bdtopo-osrm",              //ressource utilisée
     onSuccess : function (result) {
         // exploitation des resultats : "result" est de type Gp.Services.RouteResponse
         ...
@@ -315,8 +302,6 @@ Gp.Services.route({
 
 La fonction [Gp.Services.isoCurve()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~isoCurve) permet d'utiliser le service de calcul d'isochrones / isodistances de la plateforme Géoportail. Elle prend en paramètres :
 
-* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources utilisés par le calcul d'isochrones / isodistances du Géoportail : graphe routier ou piéton.
-
 * une **position de référence** (départ ou arrivée) pour le calcul.
 
 * la **limite de temps ou distance** pour le calcul.
@@ -325,18 +310,20 @@ La fonction [Gp.Services.isoCurve()](http://ignf.github.io/geoportal-access-lib/
 
 * le **graphe** utilisé pour le calcul correspondant au profil de véhicule (piéton ou routier)
 
+* la **ressource** utilisée pour le calcul d'isochrone (valhalla ou bdtopo-iso)
+
 * d'autres paramètres éventuels à passer au service...
 
 * la **fonction de traitement des résultats** qui sera appelée lorsqu'ils seront reçus. Cette fonction prend en paramètres un objet de type : [Gp.Services.IsoCurveResponse](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/Gp.Services.IsoCurveResponse.html).
 
 
 ``` javascript
 Gp.Services.isoCurve({
-    apiKey : "carte", // clef d'accès à la plateforme
     position : { x: 2, y: 45},       // point de référence
     method : "time",                   // méthode de calcul (isochrone)
     time : 1000,                       // limite de temps (isochrone)
     graph : "Pieton",                 // grapĥe utilisé
+    resource : "valhalla",              //ressource utilisée
     onSuccess : function (result) {
         // exploitation des resultats : "result" est de type Gp.Services.IsoCurveResponse
         ...
@@ -352,9 +339,9 @@ Gp.Services.isoCurve({
 
 ## Obtenir des informations relatives à un contrat d'accès au Géoportail
 
-La fonction [Gp.Services.getConfig()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~getConfig) permet de consulter les ressources disponibles pour une clef d'accès à la plateforme et d'avoir les paramètres permettant leur utilisation. Elle prend en paramètres :
+La fonction [Gp.Services.getConfig()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~getConfig) permet de consulter les ressources disponibles pour une thématique Géoplateforme et d'avoir les paramètres permettant leur utilisation. Elle prend en paramètres :
 
-* une (ou plusieurs) **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) dont on veut consulter les droits.
+* une (ou plusieurs) **thématiques Geoplateforme** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) dont on veut consulter les droits.
 
 * d'autres paramètres éventuels à passer au service...
 

diff --git a/geoportal-access-lib-3.3.4.tgz b/geoportal-access-lib-3.3.4.tgz
diff --git a/geoportal-access-lib-3.4.0-beta4.tgz b/geoportal-access-lib-3.4.0-beta4.tgz
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "geoportal-access-lib",
-  "version": "3.3.4",
-  "date": "29/08/2023",
+  "version": "3.4.0",
+  "date": "18/03/2024",
   "description": "French Geoportal resources access library",
   "module": "src/Gp.js",
   "main": "dist/GpServices-src.js",
@@ -38,6 +38,7 @@
     "url": "https://github.com/IGNF/geoportal-access-lib.git"
   },
   "keywords": [
+    "geoplateforme",
     "geoportail",
     "webservice",
     "javascript",

diff --git a/samples-src/pages/Alti/pages-alti-bundle-default.html b/samples-src/pages/Alti/pages-alti-bundle-default.html
@@ -20,8 +20,8 @@ <h2>Avec les paramètres obligatoires seulement</h2>
                   },
                   // spécifique au service
                   positions : [{
-                      lon : 1.25,
-                      lat : 47.48
+                      lon : 8.8,
+                      lat : 42
                   }]
               };
               Gp.Services.getAltitude(options);
@@ -37,8 +37,8 @@ <h2>Avec les paramètres obligatoires seulement</h2>
             },
             // spécifique au service
             positions : [{
-                lon : 1.25,
-                lat : 47.48
+                lon : 8.8,
+                lat : 42
             }]
         };
         Gp.Services.getAltitude(options);

diff --git a/samples-src/pages/Alti/pages-alti-bundle-onbeforeparse-jsonp.html b/samples-src/pages/Alti/pages-alti-bundle-onbeforeparse-jsonp.html
@@ -30,8 +30,8 @@ <h2>Avec les paramètres obligatoires seulement</h2>
                   },
                   // spécifique au service
                   positions : [{
-                      lon : 1.25,
-                      lat : 47.48
+                      lon : 8.8,
+                      lat : 42
                   }]
               };
               Gp.Services.getAltitude(options);
@@ -57,8 +57,8 @@ <h2>Avec les paramètres obligatoires seulement</h2>
             },
             // spécifique au service
             positions : [{
-                lon : 1.25,
-                lat : 47.48
+                lon : 8.8,
+                lat : 42
             }]
         };
         Gp.Services.getAltitude(options);

diff --git a/samples-src/pages/Alti/pages-alti-bundle-onbeforeparse-xhr.html b/samples-src/pages/Alti/pages-alti-bundle-onbeforeparse-xhr.html
@@ -33,8 +33,8 @@ <h2>Avec les paramètres obligatoires seulement</h2>
                 },
                 // spécifique au service
                 positions : [{
-                    lon : 1.25,
-                    lat : 47.48
+                    lon : 8.8,
+                    lat : 42
                 }]
             };
             Gp.Services.getAltitude(options);
@@ -63,8 +63,8 @@ <h2>Avec les paramètres obligatoires seulement</h2>
             },
             // spécifique au service
             positions : [{
-                lon : 1.25,
-                lat : 47.48
+                lon : 8.8,
+                lat : 42
             }]
         };
         Gp.Services.getAltitude(options);

diff --git a/samples-src/pages/Alti/pages-alti-bundle-rest-elevation.html b/samples-src/pages/Alti/pages-alti-bundle-rest-elevation.html
@@ -22,8 +22,8 @@ <h2>Avec les paramètres WPS "Elevation" en mode POST</h2>
                 },
                 // spécifique au service
                 positions : [{
-                    lon : 1.25,
-                    lat : 47.48
+                    lon : 8.8,
+                    lat : 42
                 }],
                 outputFormat : "xml", // json|xml
                 api : "REST", // REST|WPS
@@ -44,8 +44,8 @@ <h2>Avec les paramètres WPS "Elevation" en mode POST</h2>
             },
             // spécifique au service
             positions : [{
-                lon : 1.25,
-                lat : 47.48
+                lon : 8.8,
+                lat : 42
             }],
             outputFormat : "xml", // json|xml
             api : "REST", // REST|WPS

diff --git a/samples-src/pages/Alti/pages-alti-bundle-rest-profile.html b/samples-src/pages/Alti/pages-alti-bundle-rest-profile.html
@@ -21,7 +21,7 @@ <h2>Avec les paramètres WPS "Profil" en mode POST</h2>
                     print(response.elevations);
                 },
                 // spécifique au service
-                positions : [{lon:1.25, lat:47.48}, {lon:1.35, lat:47.50}],
+                positions : [{lon:8.9, lat:42}, {lon:9.1, lat:41.9}],
                 outputFormat : "xml", // json|xml
                 sampling : 3,
                 api : "REST", // REST|WPS
@@ -41,9 +41,9 @@ <h2>Avec les paramètres WPS "Profil" en mode POST</h2>
                 print(response.elevations);
             },
             // spécifique au service
-            positions : [{lon:1.25, lat:47.48}, {lon:1.35, lat:47.50}],
+            positions : [{lon:8.9, lat:42}, {lon:9.1, lat:41.9}],
             outputFormat : "xml", // json|xml
-            sampling : 3,
+            sampling : 4,
             api : "REST", // REST|WPS
             zonly : false // false|true
         };

diff --git a/samples-src/pages/Alti/pages-alti-bundle-wps-elevation.html b/samples-src/pages/Alti/pages-alti-bundle-wps-elevation.html