Aller au contenu
Vérifié

Ce qu'est un plugin

Un plugin est un paquet npm qui s'installe dans un projet Xuda et l'étend avec du code qui s'exécute dans le navigateur, dans Studio ou sur le serveur.

Un plugin Xuda est un paquet npm à portée (@xuda.io/<name> pour les plugins de première partie, n'importe quelle portée pour un tiers) qu'un projet installe pour gagner une capacité : un composant d'interface, une bibliothèque de code appelable depuis Studio, un connecteur de base de données, un framework d'interface ou un jeu d'icônes. Chaque plugin sous plugins/@xuda.io/ dans ce dépôt en est un, et la même forme fonctionne pour un plugin publié depuis l'extérieur du monorepo.

Les pièces mobiles

Le paquet sur disque

Un plugin est un paquet npm ordinaire : package.json plus ceux des six fichiers de manifeste (voir le manifeste) qu'il fournit. plugins/@xuda.io/<name> dans ce dépôt est la copie de travail des plugins de première partie ; un tiers écrit et publie la même forme depuis son propre dépôt.

Le document de catalogue

Envoyer un plugin (upload_plugin) écrit un document dans la base xuda_plugins, indexé par le nom du paquet. Ce document est à la fois la source d'installation (son manifest, sa version et son package_source disent quoi récupérer et ce que le paquet fournit réellement) et la fiche de la place de marché (label, plugin_description, tags, icon, visibility, stat) pour ce même plugin. Il n'y a pas de fiche distincte à garder synchronisée.

L'installation dans le projet

Installer un plugin dans un projet (install_plugin) fait trois choses : il installe le paquet avec npm dans le propre node_modules de ce projet (sous plugins_drive_path, un arbre par projet, pas une installation globale partagée), il enregistre le plugin dans la table app_plugins_purchased du projet (installé, version, manifeste, plugin_type), et il signale que le projet doit être reconstruit (set_update_required_to_app).

Où le code d'un plugin s'exécute réellement

Un plugin peut fournir du code pour trois endroits différents, et il ne s'exécute que là où le fichier existe :

  • Dans le navigateur, à l'intérieur de chaque application publiée où le plugin est installé, via runtime.mjs. C'est le fn(plugin_name, element, properties) d'un plugin d'interface, appelé une fois par élément auquel le plugin est rattaché.
  • Sur le serveur, à l'intérieur du projet, via server.mjs. C'est là que les methods d'un plugin de bibliothèque sont réellement implémentées, et là qu'un plugin de données (dbs) parle à son stockage.
  • Dans Studio lui-même pendant la construction du projet, via studio.mjs. Un plugin dbs s'en sert pour exécuter ses propres requêtes en direct sur la vue de table de Studio.

L'écran de consentement à l'installation qu'un utilisateur voit avant d'installer un plugin est construit directement à partir de ceux de ces fichiers que le manifeste du plugin dit fournir : c'est pourquoi le manifeste est le contrat du plugin avec la personne qui l'installe, et pas seulement un artefact de construction.

Suite