- composable useFormErrors + util mapViolationsToRecord (shared) - formulaire Client (new + edit) : erreurs inline par champ (scalaires) et par ligne pour les collections (contacts / adresses / RIB) - blocs ClientContactBlock / ClientAddressBlock : prop errors - migration de useCategoryForm sur useFormErrors - convention documentee dans .claude/rules/frontend.md
7.5 KiB
Frontend — Regles Nuxt 4 / Vue 3 / @malio/layer-ui
Base
- TypeScript strict
- 4 espaces d'indentation
- Commentaires (JSDoc, inline, bloc) en francais ; code (variables, types) en anglais
- Chaque module front = un layer Nuxt auto-detecte (
frontend/modules/*/nuxt.config.tsminimal)
Appels API
- Toujours
useApi()— jamais$fetch,ofetch,axiosen direct useApi()gere : cookies JWT, erreurs, toasts i18n, parsing Hydra
Stores (Pinia)
useAuthStorepour l'authentificationuseUiStorepour l'etat UI global (sidebar, modales, etc.)- Composables avec state singleton (refs module-level) : exposer une fonction
reset*()et la rappeler au logout (ex:useSidebar().resetSidebar())
Middlewares globaux
auth.global.tsprotege les routes + charge la sidebar apres loginmodules.global.tsredirige si la route demandee est dansdisabledRoutes
i18n et sidebar
- Labels de sidebar = cles i18n
sidebar.<module>.*, jamais du texte brut - Le layout
default.vueappliquet()sur les labels retournes par/api/sidebar - Traductions dans
frontend/i18n/locales/
Composants formulaires — @malio/layer-ui obligatoire
Tout champ de formulaire / filtre doit utiliser les composants Malio* plutot que <input> / <select> bruts :
MalioInputText,MalioInputNumber,MalioInputAmount,MalioInputPassword,MalioInputTextAreaMalioSelect,MalioSelectCheckbox,MalioCheckbox,MalioRadioButtonMalioInputUpload,MalioTimeMalioButton,MalioButtonIcon
Exceptions autorisees (commenter un // TODO pour migrer quand la lib couvrira le cas) :
- Type non couvert :
datetime-local,date, color picker, file drag & drop - Bug connu bloquant (ex:
MalioSelectavec options string) — documenter le bug en commentaire
Toute autre exception requiert validation avant merge.
Validation des formulaires — useFormErrors obligatoire (erreur par champ)
Tout formulaire qui soumet a une API DOIT afficher les erreurs de validation 422 sous le champ concerne, via useFormErrors (frontend/shared/composables/useFormErrors.ts). C'est le pendant front de « le back renvoie TOUTES les violations d'une 422 d'un coup » : un seul aller-retour, chaque erreur affichee inline sous son champ (prop :error des Malio*), pas un toast fourre-tout.
Principe cle : le nom du champ cote front = le propertyPath renvoye par le back. Aucun mapping manuel champ par champ.
Pattern de reference (champs scalaires) :
const { errors, setError, clearErrors, handleApiError } = useFormErrors()
async function submit() {
clearErrors()
try {
await useApi().post('/clients', payload, { toast: false }) // toast: false obligatoire
} catch (e) {
// 422 → mapping inline par champ (pas de toast) ; autre → toast de fallback.
handleApiError(e, { fallbackMessage: t('foo.error') })
}
}
<MalioInputText v-model="form.companyName" :error="errors.companyName" />
<MalioSelect v-model="form.siren" :error="errors.siren" />
Regles :
- Toujours
{ toast: false }sur l'appel API qui veut un mapping inline (sinon le toast natif d'useApimasque le fin). - Cas metier specifique (ex: 409 doublon) :
setError('champ', message)+ toast explicite avant de deleguer le reste ahandleApiError. Cf.useCategoryForm(doublon RG-1.07). - Collections (listes de sous-entites sauvees par un appel par ligne) : une erreur PAR LIGNE via un tableau
ref<Record<string, string>[]>aligne sur l'index, peuple parmapViolationsToRecord(error.response._data)(util pur deshared/utils/api.ts). Le composant de ligne expose une prop:errors(Record<string, string>) bindee sur le:errorde chaque champ. Cf.ClientContactBlock/ClientAddressBlocket les submits declients/new.vue/clients/[id]/edit.vue.
Interdit : se contenter d'un toast global sur une 422 quand le back identifie les champs fautifs (propertyPath). Reimplementer un mapping if/else par champ a la main au lieu d'useFormErrors / mapViolationsToRecord.
Tableaux de donnees — MalioDataTable obligatoire
Tout affichage LISTE tabulaire (donnees metier paginees, CRUD admin) doit passer par MalioDataTable :
- Pagination integree
- Slots
#header-*pour filtres,#cell-*pour rendu custom - Pas de
<table>brut avec pagination custom
Exception : tableaux purement presentationnels non paginables (diff field/old/new, grille de comparaison, matrice RBAC d'admin, etc.) peuvent rester en <table> HTML brut.
Listes paginees (standard) — usePaginatedList obligatoire
Toute liste qui consomme une GetCollection API doit passer par usePaginatedList (frontend/shared/composables/usePaginatedList.ts). Le composable est le pendant front de la regle ABSOLUE n°13 (« toute collection est paginee cote back ») : il consomme l'envelope Hydra (member / totalItems / view) et expose un etat reactif a brancher directement sur MalioDataTable.
Pattern de reference :
const {
items,
totalItems,
currentPage,
itemsPerPage,
itemsPerPageOptions,
fetch: loadList,
goToPage,
setItemsPerPage,
} = usePaginatedList<MyEntity>({ url: '/my-resources' })
onMounted(loadList)
<MalioDataTable
:columns="columns"
:items="rows"
:total-items="totalItems"
:page="currentPage"
:per-page="itemsPerPage"
:per-page-options="itemsPerPageOptions"
:empty-message="t('foo.empty')"
@update:page="goToPage"
@update:per-page="setItemsPerPage"
/>
Garanties offertes par le composable :
- Force
Accept: application/ld+json→ API Platform 4 renvoie bienmember/totalItems(sans Accept, retour tableau plat sans pagination). - Defaut 10 items/page, choix client 10 / 25 / 50, aligne sur le defaut serveur.
- Mutation
setFilters/setSort/setItemsPerPage→ retombe systematiquement en page 1. - Cas limite « page hors borne apres filtre » : retombe automatiquement sur la derniere page valide (
tests/usePaginatedList.test.ts). - Etat 100 % local (refs internes a l'instance) — jamais reflete dans l'URL, conformement a la regle « Etat des tableaux — pas de persistance URL » ci-dessous.
A NE PAS faire :
- Charger une collection complete via
?itemsPerPage=999pour bypasser la pagination. Le seul cas legitime de retour complet est l'alimentation d'un<select>sur un referentiel ≤ quelques dizaines d'entrees, et il passe par?pagination=false(echappatoire prevue parpagination_client_enabled: true). - Reimplementer la pagination prev/next a la main au-dessus de
MalioDataTable— le composant porte deja le selecteur items/page et les boutons Prev/Next. - Persister
page/tri/filtredans la query string — meme regle que pour<MalioDataTable>brut (cf. section suivante).
Etat des tableaux — pas de persistance URL
Interdit de persister l'etat d'un tableau (filtres, pagination, tri par colonne, selection, ligne active, scroll) dans la query string ou de le reinjecter depuis route.query au montage.
- L'etat vit uniquement dans le composant (
reactive,reflocales) - Seuls les deep links "de navigation metier" (ex: ouvrir un detail precis
/users/42) sont dans l'URL - Exceptions autorisees sur demande explicite de l'utilisateur
Interdits
modules-loader.ts,.module.ts— le scan des layers est automatique- Hardcode de la sidebar cote front — elle vient de
/api/sidebar - Edition manuelle de
extendsdansfrontend/nuxt.config.ts— les layers sont scannes - Import d'un module front depuis un autre module — passer par
frontend/shared/