{"id":20515539,"url":"https://github.com/ignf/geoportal-wfs-client","last_synced_at":"2025-04-14T00:25:53.279Z","repository":{"id":17947026,"uuid":"83057973","full_name":"IGNF/geoportal-wfs-client","owner":"IGNF","description":"Client JavaScript simplifiant l'accès aux WFS du géoportail (GeoJSON)","archived":false,"fork":false,"pushed_at":"2024-10-31T02:15:12.000Z","size":2950,"stargazers_count":12,"open_issues_count":3,"forks_count":3,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-27T14:47:34.179Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IGNF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-24T15:56:52.000Z","updated_at":"2024-09-11T10:46:03.000Z","dependencies_parsed_at":"2023-11-24T12:29:05.099Z","dependency_job_id":"ddd0ea06-b69f-406d-bf0e-ebca1c529a49","html_url":"https://github.com/IGNF/geoportal-wfs-client","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IGNF%2Fgeoportal-wfs-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IGNF%2Fgeoportal-wfs-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IGNF%2Fgeoportal-wfs-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IGNF%2Fgeoportal-wfs-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IGNF","download_url":"https://codeload.github.com/IGNF/geoportal-wfs-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248800112,"owners_count":21163404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T21:22:38.932Z","updated_at":"2025-04-14T00:25:53.246Z","avatar_url":"https://github.com/IGNF.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# geoportal-wfs-client\n\n![Build Status](https://github.com/IGNF/geoportal-wfs-client/actions/workflows/node.js.yml/badge.svg)\n\n\n## Description\n\nCette bibliothèque est un client d'accès spécifique aux [services WFS du géoportail](https://geoservices.ign.fr/services-web-experts) visant à simplifier l'accès aux données vectorielles.\n\nCe client reprend les principes de simplification de l'utilisation des services initiés dans le cadre d'[APICARTO](https://apicarto.ign.fr) :\n\n* Format fixe : JSON/GeoJSON\n* Projection fixe : WGS84 (longitude,latitude)\n* Requête spatiale et attributaire simple\n\nToutefois, à l'instar de [geoportal-access-lib](https://github.com/IGNF/geoportal-access-lib), ces simplifications sont disponibles côté client sans mise en oeuvre de nouveaux serveurs.\n\nRemarque : Cette bibliothèque est réutilisable avec d'autres serveurs WFS (ex : [www.geoportail-urbanisme.gouv.fr](https://www.geoportail-urbanisme.gouv.fr)) mais fait appel à des fonctionnalités spécifiques à GeoServer (ex : `cql_filter`).\n\n## Fonctionnement\n\nLa bibliothèque génère des requêtes WFS (GetCapabilities et GetFeatures avec cql_filter) en fixant des paramètres (outputFormat=application/json, projection=CRS:84, etc.) et parse les résultats.\n\n## Démonstration\n\nVoir [public/parcelle.html](https://ignf.github.io/geoportal-wfs-client/public/parcelle.html) qui illustre la récupération et l'affichage d'une parcelle au clic sur une carte leaflet.\n\n## Construction du client\n\n\n### En contexte NodeJS\n\n\n```js\nvar Client = require('geoportal-wfs-client');\n\nvar options = {\n    \"headers\":{\n        \"Referer\": 'https://mon-application.fr'\n    }\n};\nvar client = new GeoportalWfsClient(options);\n```\n\n### En contexte navigateur\n\n```js\n\u003cscript src=\"dist/geoportal-wfs-client.js\"\u003e\u003c/script\u003e\n\u003cscript type=\"text/javascript\"\u003e\n\nvar options = {};\n\nvar client = new GeoportalWfsClient(options);\n\u003c/script\u003e\n```\n\nRemarque : on ne peut pas forcer le referer depuis le navigateur\n\n## client.getTypeNames() - lister les types\n\n### Exemple d'utilisation\n\n```js\nclient.getTypeNames()\n    .then(function(typeNames){\n        console.log(typeNames);\n    })\n    .catch(function(err){\n        console.log(err);\n    })\n:\n```\n\n### Exemple de résultat\n\n```json\n[\n  \"AOC-VITICOLES:aire_parcellaire\",\n  \"BDPARCELLAIRE-VECTEUR_WLD_BDD_WGS84G:arrondissement\",\n  \"BDPARCELLAIRE-VECTEUR_WLD_BDD_WGS84G:batiment\",\n  \"BDPARCELLAIRE-VECTEUR_WLD_BDD_WGS84G:commune\",\n  \"BDPARCELLAIRE-VECTEUR_WLD_BDD_WGS84G:divcad\",\n  \"BDPARCELLAIRE-VECTEUR_WLD_BDD_WGS84G:localisant\",\n  \"BDPARCELLAIRE-VECTEUR_WLD_BDD_WGS84G:parcelle\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:arrondissement\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:batiment\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:borne_limite_propriete\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:borne_parcelle\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:commune\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:feuille\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:localisant\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:parcelle\",\n  \"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:subdivision_fiscale\",\n  \"DEVIATION_BDP_PCI_BDD_SYMBO_WLD_WM_20200428:parcelle_wld\"\n]\n```\n\n## client.getFeatures(typeName,params,method='post') - récupérer les objets d'un type\n\n### Exemple d'utilisation\n\nRécupération des parcelles de la section \"0A\" de la commune \"25349\" :\n\n```js\nconst params = {\n    code_insee: '25349',\n    section: '0A'\n};\nclient.getFeatures(\"CADASTRALPARCELS.PARCELLAIRE_EXPRESS:parcelle\", params, 'get')\n    .then(function(featureCollection){\n        console.log(featureCollection);\n    })\n    .catch(function(err){\n        console.log(err);\n    })\n;\n```\n\nExemple de résultat : [parcelles-25349-0A.json](public/parcelles-25349-0A.json)\n\n### Détails sur params\n\n`params` permet de définir des filtres cumulatifs et de gérer la pagination.\n\n* La syntaxe `{\"\u003cattributeName\u003e\":\"\u003cattributeValue\u003e\"}` permet un filtrage attributaire suivant `\u003cattributeName\u003e == \u003cattributeValue\u003e`.\n\n* Un filtrage spatial est disponible sous deux formes :\n\n    * `bbox` permet de filtrer par boite englobante\n    * `geom` permet de filtrer par une géométrie intersectante\n\n* La pagination est gérée via deux paramètres :\n\n    * `_limit` : Le nombre maximum de résultats (équivalent à `COUNT` sur le WFS, définit par défaut au niveau du flux)\n    * `_start` : Indexe du premier résultat (0 par défaut, équivalent à `STARTINDEX` sur le WFS)\n\n* Récupérer seulement certain champs :\n\n    * `_propertyNames` : La liste des propriétés demandées dans le résultat\n\n### Remarque sur les performances\n\n~~Certains types WFS Géoportail correspondent à l'agrégation de plusieurs schémas de données. Ceci implique qu'en l'absence de filtrage, les requêtes WFS peuvent être sous-performante ou en échec~~.\n\nLes résultats au format GeoJSON incluent un comptage (`totalFeatures`, `numberMatched`, `numberReturned`). L'opération correspondante étant coûteuse, les requêtes WFS peuvent être sous-performante ou en échec en l'absence de filtrage.\n\nA titre d'exemple, les requêtes `getFeatures('CADASTRALPARCELS.PARCELLAIRE_EXPRESS:parcelle',params)` seront sous performantes ou en échec si `params` ne contient pas l'un des éléments suivants : `code_insee`, `geom` ou `bbox`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fignf%2Fgeoportal-wfs-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fignf%2Fgeoportal-wfs-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fignf%2Fgeoportal-wfs-client/lists"}