mon-entreprise/publicodes/docs/api.md

API

IMPORTANT : publicodes est encore en version beta, et l'API peut-être sujette à des changements cassants lors de prochaines versions. Pour plus d'informations, se référer à la feuille de route v1.0

new Engine(rules)

Crée un moteur d'évaluation avec les règles publicodes données en argument.

Arguments

• rules : les règles publicodes utilisées. Ces dernières peuvent être sous la forme d'une chaîne de caractère yaml publicodes (ou d'un objet javascript correspondant). Elle peuvent aussi être sous la forme de règles publicodes déjà parsées.

Retourne Un moteur d'évaluation qui expose les fonctions suivantes :

• setSituation
• evaluate
• getRule

method engine.setSituation(situation)

Permet de spécifier une situation en entrée. Toutes les prochaines évaluations seront effectuées en se basant sur ces valeurs plutôt que les valeurs présentes dans la base de règles.

C'est le point d'entrée principal pour adapter les calculs de règles générales à une situation particulière. La situation est gardée en mémoire, et chaque appel à setSituation remplace la situation précédente. Le moteur contient donc un état interne. Cela permet d'obtenir de meilleures performances, avec une gestion plus fine du cache de calcul. En revanche, il faut prêter une grande attention à la bonne gestion de cet état interne.

Arguments

• situation : un objet javascript qui associe le nom complet d'une règle à sa valeur. Cette valeur peut être n'importe quelle expression publicodes bien formée. Elle sera évaluée par le moteur. Cela permet de spécifier des nombres avec unité, des expressions, des références vers d'autres règles ou même d'utiliser des mécanismes.

Retourne

L'objet engine (this) sur lequel la fonction a été appelée, afin de pouvoir utiliser une écriture chaînée (engine.setSituation(situation).evaluate()).

method engine.evaluate(expression)

Évalue l'expression dans le contexte du moteur (règle et situation).

Pour des raisons de performance, les résultats intermédiaires sont enregistrés dans un cache. Par conséquent, les appels suivants seront plus rapides.

Arguments

• expression: la valeur à évaluer. Cela peut-être n'importe quelle expression publicodes bien formée (expression arithmétique, mécanisme, réference vers une règle).

Retourne

Un objet javascript de type EvaluatedNode contenant la valeur calculée.

Attention ! Il est déconseillé d'utiliser directement les valeurs présentes dans l'objet retourné, étant donné que leur forme va très probablement changer au cours des prochaines versions du moteur. Utilisez la fonction formatNode(evaluationResult) autant que possible pour afficher la valeur retournée.

• missingVariables: contient les règles dont la valeur est manquante dans la situation
• nodeValue: la valeur calculée (type string, number, boolean, ou null)
• unit: si nodeValue est un nombre, contient l'unité associée

function formatValue(evaluatedNode, \[options\])

Formate la valeur evaluée.

Arguments

• evaluatedNode : l'objet retourné lors de l'appel à la fonction d'évaluation du moteur evaluate(expression)
• options : configuration pour le formatage
  • language: le langage utilisé pour le formatage (par défaut fr)
  • precision: le nombre de chiffre après la virgule pour le formatage des nombres (par défaut 2)
  • displayedUnit: l'unité à afficher pour le formatage des nombres. Outrepasse l'unité définie dans le calcul (on peut donc forcer l'unité affichée à une autre que celle retournée par le calcul, même si elle ne sont pas compatibles)

Retourne

La chaîne de caractère correspondant à la valeur bien formatée.

Composants React

Publicodes exporte des composants React permettant d'afficher une documentation explorable des calculs. Cette documentation est auto-générée en s'appuyant sur les données descriptives contenues dans les règles publicodes (description, références, titre, note, etc.) et en affichant pour chaque règle les étapes intermédiaires qui permettent d'aboutir au résultat affiché.

Voir un exemple sur mon-entreprise.fr

<RulePage />

Composant React permettant d'afficher la page de documentation d’une règle donnée.

Voir le bac à sable pour voir le composant en action (il est affiché sur l'écran de droite).

Props

• engine: l'objet moteur dont on veut afficher les calculs.
• documentationPath : (string) le chemin de base sur lequel la documentation sera montée. Par exemple, si c'est /documentation l'url de la règle rémunération . primes sera /documentation/rémunération/primes
• rulePath: (string) le chemin de la règle à afficher
• language: le language dans lequel afficher la documentation (pour l'instant, seuls fr et en sont supportés).
• renderers: { Head?: React.Component, Link: React.Component } : les composants React qui seront utilisés dans la page de documentation.
  • Link: pour afficher les liens. Le composant prend un argument to
  • Head: pour afficher les en-têtes de la page, balises <meta>, <title>, etc.
  • References: pour personnaliser l'affichage des références en pied de page. Le composant reçoit l'objet références brut définit dans le Yaml.

En général, on voudra afficher la documentation pour l'ensemble des pages et non pour une page en particulier. Il faut donc associer le composant <RulePage /> avec le routeur utilisé.

Par exemple pour react-router :

import { Route, Link } from 'react-router-dom'
import { RulePage } from 'publicodes/react-ui'

export function Documentation() {
    return (
        <Route
            path="documentation/:name+"
            render={({ match }) => (
                <RulePage
                    documentationPath="/documentation"
                    rulePath={match.params.name}
                    language="fr"
                    renderers={{ Link }}
                />
            )}
        />
    )
}

Autre exemple pour intégrer la documentation dans une application Next.js :

// pages/documentation/[...slug].jsx
import Head from 'next/head';
import Link from 'next/link'
import { useRouter } from 'next/router'

export default Documentation() {
  const { slug } = useRouter().query;
  return <RulePage
    documentationPath="/documentation"
    rulePath={slug.join('/')}
    language="fr"
    renderers={{
      Head,
      Link: ({to, children}) => <Link href={to}><a>{children}</a></Link>
    }}
  />
}

Vous pouvez même afficher cette documentation dans une application qui n'est pas développée en React, en “montant” React seulement pour la partie documentation. Par exemple dans une application Svelte :

<script>
    import { onMount } from 'svelte'
    import { goto } from '$app/navigation'
    import { createElement } from 'react'
    import { render } from 'react-dom'
    import { RulePage } from 'publicodes/react-ui'

    let domElement

    // A Link React component that calls SvelteKit `goto` on click
    function Link({ to, children }) {
        const onClick = (evt) => {
            evt.preventDefault()
            goto(to)
        }
        return createElement('a', { onClick }, children)
    }

    const props = {
        renderers: { Link },
        // other props left as an exercice to the reader
    }

    onMount(() => {
        render(createElement(RulePage, props), domElement)
    })
</script>

<div bind:this="{domElement}" />

<RuleLink />

Composant React permettant de faire un lien vers une page de la documentation. Par défaut, le texte affiché est le nom de la règle.

Props

• engine: l'objet moteur dont on veut afficher la règle.
• documentationPath : (string) le chemin de base sur lequel la documentation est montée. Doit correspondre à celui précisé pour le composant <RulePage />
• dottedName: le nom de la règle à afficher
• linkComponent: le composant utilisé pour afficher le lien. C'est la même interface que pour le composant <RulePage />. Il prend une unique prop to qui est le chemin vers la règle.
• displayIcon: affiche l'icône de la règle dans le lien (par défaut à false)
• children: un noeud React quelconque. Par défaut, c'est le nom de la règle qui est utilisé.