Documentation — Commentaires

Fil de commentaires et annotations sur une entité (document, ligne, projet). Auteur, date et contenu.

Les modules Blueprint Modular font partie de l'application Next.js. Il n'y a pas de package séparé par module : on installe l'application une fois. Cette documentation décrit comment fonctionne le module Commentaires (affichage, ajout, liaison à une entité), comment l'intégrer (API ou store) et les données attendues.

Comment fonctionne le module Commentaires

Le module affiche un fil de commentaires associé à une entité (document, ligne, projet). Un contexte optionnel (nom + lien de l'entité) peut être affiché en en-tête pour rappeler sur quoi portent les commentaires. Chaque commentaire comporte un auteur (format structuré pour avatars), une date, un contenu, et optionnellement un type (commentaire / annotation / décision / blocage) et un statut résolu. Zone de saisie multi-lignes (Ctrl+Entrée pour envoyer) et bouton Envoyer. Les données sont persistées côté backend (API ou base) selon votre implémentation.

Structure des commentaires

Champs de base et champs optionnels (pour threading, résolution, type) :

  • id, entityId / entityType, content, date (ISO)
  • author — format structuré recommandé : { id, displayName, avatar? } pour cohérence et avatars
  • parentId — pour réponses imbriquées (optionnel)
  • type — commentaire / annotation / décision / blocage (optionnel)
  • resolved, resolvedBy, resolvedAt — clôture (optionnel)
  • editedAt — trace des modifications (optionnel)
  • attachments — pièces jointes (optionnel)

Connexions inter-modules

Le module Commentaires s'intègre avec :

  • Notifications ciblées — notifier les participants ou les @mentionnés à chaque nouveau commentaire
  • Audit / Log — tracer les créations, modifications et suppressions de commentaires dans le journal d'audit
  • Workflow — un commentaire de type "blocage" peut conditionner une transition d'état (ex. blocage levé → passage à "En revue")

Intégration côté app

La page du module est /modules/commentaires. Pour alimenter et enregistrer les commentaires, exposez par exemple GET /api/comments?entityId=...&entityType=... et POST /api/comments. La session utilisateur (NextAuth) fournit l'auteur du commentaire. Aucune variable d'environnement spécifique n'est requise.

Exemple — afficher et ajouter un commentaire :

bpm.title("Commentaires")
# Conteneur épuré (sans bpm.panel) : fil + zone "Nouveau commentaire" (textarea + Envoyer)
# GET /api/comments?entityId=... & POST /api/comments

Simulateur

Le simulateur propose un fil long (20+ commentaires) avec types variés (commentaire, annotation, décision, blocage), réponses imbriquées, commentaires résolus, contexte d'entité, avatars colorés, actions au survol (modifier, supprimer, marquer résolu), zone multi-lignes (Ctrl+Entrée pour envoyer), validation, chargement et pagination.

Ouvrir le simulateur Commentaires

← Retour au module Commentaires