Widgets personnalisés
Les widgets personnalisés seront disponibles à partir de SKOOR 10.0.0.
Les widgets personnalisés étendent l'écosystème de visualisation SKOOR en permettant aux développeurs de créer des composants d'interface utilisateur interactifs et sur mesure qui s'exécutent en toute sécurité dans les tableaux de bord SKOOR. Ils combinent la flexibilité des frameworks web modernes (tels que React ou Vue, ou simplement Vanilla JS) avec des outils de build modernes (tels que Vite ou Webpack), tout en s'appuyant sur les pipelines de données gouvernés et les normes de sécurité strictes de SKOOR.
Guide de démarrage rapide
Pour utiliser des widgets personnalisés, vous aurez besoin d'identifiants pour le SKOOR Registry. Contactez support@skoor.com pour les demander.
Utilisez le paquet @skoor/create-custom-widget pour générer la structure de base d'un nouveau projet de widget personnalisé SKOOR avec l'architecture et les dépendances recommandées.
Ouvrir la page du paquet : https://www.npmjs.com/package/@skoor/create-custom-widget
Générer un projet de widget : Suivez les instructions du paquet pour créer un nouvel espace de travail de widget personnalisé.
Compiler, tester et publier : Implémentez le widget, validez-le localement, puis publiez-le dans le SKOOR Package Registry sous le scope client attribué.
Fonctionnement des widgets personnalisés
Les widgets personnalisés fonctionnent comme des paquets isolés et autonomes, distribués et gérés via le SKOOR Package Registry centralisé (registry.skoor.com).
Point d'entrée (
main) : Chaque paquet de widget définit un fichier HTML comme point d'entréemaindanspackage.json. Toutes les ressources statiques requises (scripts, styles, images) sont chargées directement depuis le registre.Exécution isolée : Les widgets s'exécutent dans des IFRAME isolées par une origine dédiée et une politique Content Security Policy (CSP) restrictive. Cela garantit la séparation des locataires, la sécurité et un contrôle strict des limites.
Méthodes de création : Les widgets personnalisés peuvent être conçus manuellement par des développeurs à l'aide de n'importe quel flux de développement local moderne (par exemple Vite, Webpack ou Vanilla JS) ou générés via l'IA pour échafauder rapidement des tableaux de bord et des composants fonctionnels.
Structure du paquet et requêtes de données
Pour rester entièrement portables et versionnés, les widgets personnalisés intègrent leurs définitions de données requises directement dans le paquet sous le bloc de configuration skoor :
Requêtes intégrées : Les paquets incluent leurs requêtes de base de données requises sous la propriété
skoor.dataQueryPackage, qui pointe vers un fichier JSON de requêtes exporté. Utilisez l'outil d'exportation du server MCP SKOOR pour exporter un groupe de requêtes dédié ; l'exportation inclut automatiquement les dépendances requises.Le Dashboard Bridge (
@skoor/dashboard-bridge) : Les widgets communiquent avec la plateforme centrale SKOOR exclusivement via la bibliothèque officielle@skoor/dashboard-bridge. Ce pont abstrait la communication asynchrone (viapostMessageet Penpal), permettant aux widgets de :Récupérer des données dynamiquement à l'aide de
dataQuerySelect(...)oudataSourceSelect(...).Lire et mettre à jour les filtres globaux du tableau de bord (
getFilters(),setFilters(...)).Synchroniser automatiquement le style hôte, les variables de thème, les familles de polices et les hauteurs de contenu via
setup().
Exemple de configuration package.json pour un widget personnalisé (publié sous un scope client, par ex. @customer-scope/custom-metric-widget) :
{
"name": "@customer-scope/custom-metric-widget",
"version": "1.0.0",
"main": "dist/index.html",
"skoor": {
"dataQueryPackage": "./data/data-queries.json"
}
}
Développement, intégration du server MCP et publication
Pour développer et publier efficacement des widgets personnalisés, vous pouvez connecter vos assistants de codage IA directement à votre instance SKOOR à l'aide du server Model Context Protocol (MCP) intégré.
Utilisation du server MCP SKOOR (Récupération, Création, Mise à jour, Exportation)
Le server MCP SKOOR permet aux clients LLM externes (tels que Cursor ou Cline) de récupérer, créer, modifier et exporter des définitions de tables et de requêtes de données directement depuis votre instance SKOOR :
Récupération : Interrogez les schémas de base de données, les structures de tables et les définitions de requêtes de données existantes pour comprendre les modèles de données disponibles.
Création : Générez automatiquement de nouvelles requêtes de données et structurez des définitions de widgets selon vos spécifications exactes.
Mise à jour / Modification : Affinez les requêtes de manière itérative, ajustez les agrégations ou modifiez les paramètres directement dans votre environnement de développement avec une validation complète du schéma.
Exportation : Exportez les paquets de requêtes de données au format JSON à l'aide de l'outil d'exportation du server MCP. Placez les requêtes spécifiques au widget dans un groupe dédié, exportez ce groupe, et l'exportation inclura automatiquement les dépendances requises.
Configurez votre client MCP (par ex. dans les paramètres de votre projet ou vos paramètres globaux) à l'aide du modèle de configuration HTTP suivant :
{
"servers": {
"skoor-mcp": {
"type": "http",
"url": "https://<your-skoor-instance>/skoor-webservice/mcp",
"headers": {
"Authorization": "Basic <your-base64-encoded-credentials>"
}
}
},
"inputs": []
}
Configuration du registre et publication
Configurer le registre : Créez un fichier
.npmrcà la racine de votre projet avec le point de terminaison du registre privé SKOOR :registry=https://registry.skoor.com
S'authentifier : Connectez-vous au registre à l'aide des identifiants fournis par SKOOR :
npm login --registry=https://registry.skoor.com
Scopes client : Les paquets doivent toujours être publiés dans votre scope client attribué (par ex.
@customer-scope/my-widget).
Sécurité, restrictions réseau et CSP
Pour protéger la souveraineté des données d'entreprise et empêcher toute fuite de données non autorisée vers des tiers, SKOOR applique des politiques de sécurité strictes aux widgets personnalisés :
Isolation par défaut : Toute communication réseau externe depuis l'intérieur d'un widget est strictement interdite et bloquée par défaut via une politique Content Security Policy (CSP) restrictive.
Exceptions CSP : Si un widget nécessite explicitement de communiquer avec des points de terminaison externes (tels que des API publiques ou des dépôts tiers), des exceptions peuvent être déclarées sous la section
skoor.cspdanspackage.json:
{
"skoor": {
"csp": {
"connect-src": [
"https://api.external-service.com"
]
}
}
}
Confirmation utilisateur : Lorsqu'un widget demande des origines réseau supplémentaires via sa configuration CSP, la plateforme affiche une boîte de dialogue de confirmation aux administrateurs ou aux utilisateurs afin d'autoriser explicitement l'accès sortant aux données.
Cycle de vie : installation et déploiement sur les tableaux de bord
Le déploiement et l'utilisation d'un widget personnalisé suivent un cycle de vie administratif et opérationnel simple :
Publication : Les développeurs compilent et publient le paquet versionné dans le SKOOR Package Registry privé (
registry.skoor.com).Installation : Les administrateurs accèdent à SKOOR Settings, localisent la section de gestion Custom Widgets et installent le paquet souhaité depuis le registre privé.
Intégration au tableau de bord : Une fois installé, le widget personnalisé devient disponible dans le WYSIWYG Dashboard Builder, où les utilisateurs peuvent le placer sur des tableaux de bord, configurer ses paramètres d'affichage et le lier aux filtres globaux du tableau de bord.