Cos'è un plugin
Un plugin è un pacchetto npm che si installa in un progetto Xuda e lo estende con codice che gira nel browser, in Studio o sul server.
Un plugin Xuda è un pacchetto npm con scope (@xuda.io/<name> per i plugin proprietari, qualsiasi
scope per quelli di terze parti) che un progetto installa per aggiungere una funzionalità: un
componente UI, una libreria di codice richiamabile da Studio, un socket di database, un framework
UI o un set di icone. Ogni plugin in plugins/@xuda.io/ in questo repository ne è un esempio, e la
stessa struttura vale per un plugin pubblicato da fuori del monorepo.
I pezzi in gioco
Il pacchetto su disco
Un plugin è un normale pacchetto npm: package.json più quanti dei sei file del manifest (vedi
il manifest) include. plugins/@xuda.io/<name> in questo repository è la
copia di lavoro dei plugin proprietari; una terza parte scrive e pubblica la stessa struttura dal
proprio repository.
Il documento del catalogo
Caricare un plugin (upload_plugin) scrive un documento nel database xuda_plugins, con chiave il
nome del pacchetto. Quel documento è sia la sorgente di installazione (il suo manifest, version e
package_source dicono cosa scaricare e cosa il pacchetto contiene davvero) sia la scheda nel
marketplace (label, plugin_description, tags, icon, visibility, stat) dello stesso
identico plugin. Non c'è un record di scheda separato da tenere sincronizzato.
L'installazione nel progetto
Installare un plugin in un progetto (install_plugin) fa tre cose: installa il pacchetto con npm
nel node_modules del progetto stesso (sotto plugins_drive_path, un albero per progetto, non
un'installazione globale condivisa), registra il plugin nella mappa app_plugins_purchased del
progetto (installed, version, manifest, plugin_type) e segnala che il progetto richiede una nuova
build (set_update_required_to_app).
Dove gira davvero il codice di un plugin
Un plugin può includere codice per un massimo di tre posti diversi, e gira solo dove il file esiste:
- Nel browser, dentro ogni app pubblicata che ha il plugin installato, tramite
runtime.mjs. È lafn(plugin_name, element, properties)di un plugin UI, chiamata una volta per ogni elemento a cui il plugin è collegato. - Sul server, dentro il progetto, tramite
server.mjs. Qui sono implementati davvero imethodsdi un plugin libreria, ed è qui che un plugin dati (dbs) dialoga con il proprio archivio. - Dentro Studio stesso mentre il progetto viene costruito, tramite
studio.mjs. Un plugindbslo usa per eseguire le proprie query in tempo reale nella vista tabella di Studio.
La schermata di consenso all'installazione che un utente vede prima di installare un plugin è costruita direttamente in base a quali di questi file il manifest del plugin dichiara di includere: per questo il manifest è il contratto del plugin con chi lo installa, e non solo un artefatto di build.