Schéma JSON
Le schéma d'application Sovrium décrit la structure complète d'une configuration d'application. Il est publié sous forme de schéma JSON standard (Draft 2020-12), dérivé directement du schéma Effect canonique (AppSchema) — il ne peut donc jamais dériver de ce que le serveur décode réellement.
Trois artefacts sortent de cette source unique de vérité :
| Artefact | Format | Généré par | À utiliser pour |
|---|---|---|---|
| Schéma JSON | JSON (Draft 2020-12) | sovrium schema |
Autocomplétion dans l'éditeur, validation CI |
@sovrium/types |
TypeScript .d.ts |
paquet npm | Autocomplétion defineConfig() dans app.ts |
| Validateur AppSchema | décodage runtime | sovrium validate |
Vérifier un fichier de configuration avant déploiement |
Explorateur de schéma interactif. Parcourez le schéma complet visuellement — dépliez les propriétés, consultez les types et explorez les structures imbriquées.
Générer le schéma
# Afficher le schéma JSON sur la sortie standard
sovrium schema
# Écrire le schéma JSON dans un fichier
sovrium schema --output app.schema.jsonLe document est autonome, avec une déclaration $schema de premier niveau : tout outil compatible JSON Schema le consomme sans configuration supplémentaire. Il ne prend aucune entrée hormis la version de Sovrium — régénérez-le en CI et comparez le résultat : toute différence est un vrai changement de schéma.
Propriétés racine en un coup d'œil
Chaque propriété sauf name est optionnelle et vient se superposer.
| Propriété | Type | Description |
|---|---|---|
name |
string |
Nom de l'application (requis) |
version |
string |
Chaîne de version de la configuration |
description |
string |
Description lisible par un humain |
tables |
object[] |
Tables de données (voir Aperçu des tables) |
pages |
object[] |
Pages et leurs arbres de composants |
forms |
object[] |
Formulaires autonomes |
auth |
object |
Configuration de l'authentification et du RBAC |
theme |
object |
Tokens de design (couleurs, polices, espacements) |
components |
object[] |
Composants réutilisables |
automations |
object[] |
Flux de travail déclencheur/action |
connections |
object[] |
Connexions à des services externes |
languages |
object |
Internationalisation / i18n |
analytics |
object |
Analytique respectueuse de la vie privée |
agents |
object[] |
Agents IA |
La référence complète se trouve dans Vue d'ensemble du schéma.
URLs du schéma
Référencez le schéma hébergé par son URL depuis un éditeur, un pipeline CI ou un script de validation.
Versionné (recommandé)
Épinglez à une version précise pour la stabilité en production. Remplacez <version> par la version de Sovrium que vous ciblez — celle qu'affiche sovrium --version :
https://sovrium.com/schema/app-<version>.jsonUne URL épinglée est celle qui garde la CI honnête : la configuration est vérifiée face au schéma de la version que vous déployez réellement, si bien que monter Sovrium de version et adopter son nouveau schéma restent deux décisions distinctes.
Dernière version
Pointe toujours vers la version la plus récente. Pratique en développement ; elle peut introduire des changements incompatibles sans prévenir.
https://sovrium.com/schema/app.jsonIntégration à l'éditeur
Déplacé vers Configuration de l'éditeur.
Autocomplétion TypeScript avec @sovrium/types
Déplacé vers Configurations TypeScript.
Valider un fichier de configuration
Déplacé vers Valider une configuration.
Validation programmatique
Déplacé vers Valider une configuration.
Pages associées
- Configuration de l'éditeur — brancher le schéma dans VS Code ou JetBrains.
- Valider une configuration —
sovrium validateet le contrôle en CI. - Configurations TypeScript — les mêmes garanties dans
app.ts. - Vue d'ensemble du schéma — la référence complète des propriétés racine.
Dernière mise à jour 28 août 2026
Cette documentation a été rédigée avec de l'IA : des erreurs ou du contenu obsolète sont donc possibles. Sovrium est en bêta. Les contributions et corrections sont les bienvenues.