Aller au contenu

La fiche d'identité d'un module

Les types de la fiche d'identité d'un module, générés à partir du code.

Voir en Markdown

La fiche d’identité d’un module dit au cœur ce que le module apporte : son code, ses entrées de menu, ses droits, ses blocs sur les fiches du cœur, ses pages de réglages, ses routes et ce qu’il possède dans la base. Le cœur ne nomme jamais un module : il lit ces fiches par le registre. Voir les portes.

Une entrée de menu qu’un module fournit : elle dit après quelle adresse elle se place.

type EntreeDeMenuDeModule = EntreeDeMenu & { … }

L’objet d’une fiche du cœur sur laquelle un module peut poser un bloc.

type ObjetDeBloc = "employe" | "operation" | "affaire" | "client"

L’emplacement d’une fiche : il dit sur quelle fiche le bloc se pose.

type EmplacementDeBloc = `fiche-${ObjetDeBloc}`

Ce qu’une fiche du cœur donne à un bloc : l’objet dont elle parle, les données que le module a fournies pour cet emplacement, et les droits que la fiche a déjà lus.

Propriété Type Obligatoire Rôle
objet ObjetDeBloc oui
id string oui
donnees unknown oui
droits readonly string[] non

Un bloc que le module pose dans un emplacement d’une fiche du cœur ; le cœur le dessine sans le connaître. Le composant se charge quand la fiche le dessine, pour que le registre se lise sans ouvrir de code d’écran.

Propriété Type Obligatoire Rôle
emplacement EmplacementDeBloc oui
composant () => Promise<ComponentType<ContexteDeBloc>> oui
Propriété Type Obligatoire Rôle
code string oui Le code de la table module.
nom string oui
menu readonly EntreeDeMenuDeModule[] oui
droits readonly string[] oui
blocs readonly Bloc[] oui
reglages readonly PageDeReglageDUnModule[] oui
routes readonly string[] oui Les préfixes d’adresse que le module possède. Une route sous l’un d’eux n’ouvre que si le module l’est.
sql SqlDuModule oui