Ce paquet est un emballage léger autour du moteur publicodes et de la base d'aides vélo écrite dans ce langage. L'objectif est d'avoir une interface simple pour faciliter l'intégration de ces données sur des sites tiers, en particulier sur https://www.1jeune1solution.gouv.fr/mes-aides.
Idéalement on ne devrait pas avoir besoin de ce paquet, en effet on pourrait utiliser directement l'API publicodes pour récupérer toutes les informations utiles depuis la base de règles. Cela nécessite sans doute encore quelques améliorations côté publicodes pour être réellement facile à utiliser. Et donc en attendant ce paquet joue le rôle de “colle” pour faciliter l'interfaçage, et garantir la retro-compatibilité en cas d'évolutions du moteur sous-jacent.
La liste des aides est disponible sur https://mesaidesvelo.fr/liste-aides
Pour obtenir la liste de toutes les aides vélo :
import aidesVelo from 'aides-velo';
console.log(aidesVelo());Il est possible de restreindre cette liste à un pays en particulier :
aidesVelo({ 'localisation . pays': 'france' });Par défaut le montant de l'aide n'est pas donné. En effet il dépend du type de vélo, ce que l'on peut préciser avec vélo . type :
aidesVelo({
'localisation . pays': 'france',
'vélo . type': 'électrique',
});Le montant de l'aide peut être affiné avec d'autres variables en entrée. La liste est disponible via le typage Typescript. D'autres exemples sont disponibles dans le fichier de tests.