Intégration : modules et composants

Cette page est la référence publique pour intégrer les modules métier et les composants BPM de Blueprint Modular dans une autre application, sans accès au dépôt Git.

Ce qu’il faut faire pour utiliser les modules

En tant que développeur ou utilisateur, voici les étapes pour intégrer les modules Blueprint Modular dans votre propre application :

1. Télécharger le bundle — Récupérez l’archive officielle : blueprint-modules-latest.zip (ou une version figée blueprint-modules-vX.Y.Z.zip depuis versions.html). Aucun compte ni accès Git requis.
2. Décompresser — Ouvrez le zip dans un répertoire temporaire. Vous obtenez les dossiers modules/, components/bpm/, lib/, prisma/ et le README-BUNDLE.md.
3. Copier dans votre projet — Collez les dossiers dans votre application Next.js (ou équivalent) :
   • modules/* → par ex. app/(app)/modules/blueprint/ (ou votre structure de routes)
   • components/bpm/ → components/bpm/
   • lib/* → lib/ (en fusionnant avec vos fichiers existants si besoin)
   • Extraits de prisma/schema.prisma → fusionnez les modèles dans votre schema.prisma (voir API et doc BDD).
4. Configurer l’environnement — Définissez au minimum DATABASE_URL, NEXTAUTH_SECRET, NEXTAUTH_URL. Selon les modules : config domaines (Gestion de parc), AI_SERVER_URL (module IA), etc. Voir la doc de chaque module et .env.example dans le dépôt source.
5. Base de données — Exécutez npx prisma generate, puis npx prisma migrate deploy (ou fusionnez les migrations selon votre stratégie). Les tables utilisées par chaque module sont décrites dans la documentation déployée (DATABASE.md dans le dépôt).
6. Styles — Copiez les parties utiles de app/globals.css (variables --bpm-*, classes .bpm-*, éventuellement .asset-manager-page si vous utilisez la Gestion de parc).
7. Navigation — Adaptez votre menu ou layout pour pointer vers les routes des modules copiés (ex. /modules/asset-manager/..., /modules/wiki).

Pour une liste détaillée des modules et des routes API, voir les sections Tous les modules (UI) et API (routes backend) ci-dessous.

Propriété intellectuelle et licence

Blueprint Modular (code des modules, composants BPM, librairies livrées dans le bundle ou le package PyPI) est distribué sous licence MIT. En utilisant les modules vous acceptez les termes de cette licence.

• Ce que vous pouvez faire : utiliser, modifier, fusionner, publier et distribuer le code Blueprint Modular dans vos propres projets (y compris commerciaux). Vous restez propriétaire du code que vous écrivez ; l’intégration de nos modules dans votre application ne transfère pas la propriété de votre code à Blueprint Modular.
• Ce que vous devez faire : conserver la notice de licence et le copyright Blueprint Modular sur les fichiers que vous réutilisez tels quels (ou sur les parties dérivées, selon la MIT). Une mention dans votre documentation ou un fichier NOTICE est recommandée (ex. « Ce projet inclut des modules Blueprint Modular, licence MIT »).
• Pas de garantie : le logiciel est fourni « tel quel », sans garantie d’aucune sorte. Utilisation sous votre responsabilité.

Pour les textes complets de la licence MIT, consultez le fichier LICENSE à la racine du dépôt source ou du package PyPI. En cas de doute sur un usage commercial ou la propriété intellectuelle, adressez-vous au mainteneur du projet (voir la doc ou le dépôt).

Sans accès Git : télécharger le bundle

Tout développeur peut récupérer les modules et composants sans avoir accès au dépôt en téléchargeant le zip officiel :

• Dernière version : blueprint-modules-latest.zip
• Version spécifique : ../downloads/blueprint-modules-vX.Y.Z.zip (voir versions.html pour la version actuelle)

Le zip contient : modules/ (tous les modules UI), components/bpm/ (design system), lib/, prisma/ (schéma et migrations), et un README-BUNDLE.md avec les instructions de copie dans votre projet. Aucun clone Git nécessaire.

Dans votre script de sync (ou manuellement) : téléchargez le zip depuis l’URL ci-dessus, décompressez, puis copiez les dossiers dans votre application comme indiqué dans le README du bundle.

Pour les utilisateurs du package PyPI

Si vous avez installé pip install blueprint-modular, un fichier de référence est inclus dans le package. En Python :

import bpm
# Chemin du fichier de référence (après installation)
# import bpm; print(bpm.__path__[0])  → répertoire du package
# Fichiers : integration-reference.md et manifest.json

Le manifest.json contient l’URL de cette page et la liste des modules/composants. Voir aussi Versions.

Tous les modules (UI)

Chaque module est une section sous app/(app)/modules/<nom>/ dans le dépôt source. Liste des modules disponibles :

API (routes backend)

Les routes API sont exposées sous app/api/. Préfixes principaux :

Composants BPM (design system)

Les composants sont dans components/bpm/. Exports principaux (liste non exhaustive) :

Accordion, AreaChart, Audio, Autocomplete, Avatar, Badge, BarChart, Barcode, Breadcrumb, Button, Card, Checkbox, Chip, CodeBlock, ColorPicker, Column, Container, DateInput, DateRangePicker, Divider, Drawer, Empty, EmptyState, Expander, FAB, FileUploader, Grid, HighlightBox, Html, Image, Input, JsonViewer, LineChart, LoadingBar, Map, Markdown, Message, Metric, Modal, NumberInput, NfcBadge, Pagination, Panel, PdfViewer, PlotlyChart, Popover, Progress, QRCode, RadioGroup, Rating, ScatterChart, Selectbox, Skeleton, Slider, Spinner, SpinnerDot, StatusBox, Stepper, Table, Tabs, Text, Textarea, Timeline, Title (Title1–4), Toast, Toggle, Tooltip, TopNav, Treeview, Video, Theme.

Point d’entrée dans le dépôt : components/bpm/index.ts. Styles : app/globals.css (variables --bpm-*, classes .bpm-*).

Intégration par copie/sync

Pour intégrer les modules et composants dans une autre application sans accès au dépôt, vous pouvez :

• Appeler l’API d’une instance Blueprint Modular déployée (voir Déployer). Votre app envoie des requêtes HTTP vers les routes listées ci-dessus.
• Récupérer le code si vous avez accès au dépôt (clone, sous-module) : copier app/(app)/modules/, app/api/, components/bpm/, lib/ (selon besoins), prisma/schema.prisma et migrations, et les parties de app/globals.css liées à BPM. Détails complets dans le fichier INTEGRATION.md à la racine du dépôt (visible uniquement avec accès au repo).

Prérequis communs : base PostgreSQL (Prisma), variables d’environnement (DATABASE_URL, NEXTAUTH_SECRET, NEXTAUTH_URL), et selon les modules : config (ex. fichiers domaines pour la gestion de parc), voir la doc déployée et docs/DATABASE.md dans le dépôt.