Přeskočit na obsah
Ověřeno

Co je plugin

Plugin je balíček npm, který se nainstaluje do jednoho projektu Xuda a rozšíří ho o kód běžící v prohlížeči, ve Studiu nebo na serveru.

Plugin Xuda je balíček npm s oborem (@xuda.io/<name> pro pluginy první strany, libovolný obor pro třetí stranu), který projekt nainstaluje, aby získal schopnost: komponentu UI, kódovou knihovnu volatelnou ze Studia, databázovou zásuvku, framework UI nebo sadu ikon. Každý plugin v plugins/@xuda.io/ v tomto repozitáři je takový a stejný tvar funguje pro plugin publikovaný mimo monorepo.

Pohyblivé části

Balíček na disku

Plugin je běžný balíček npm: package.json plus ty z šesti souborů manifestu (viz manifest), které dodává. plugins/@xuda.io/<name> v tomto repozitáři je pracovní kopie pluginů první strany; třetí strana píše a publikuje stejný tvar z vlastního repozitáře.

Dokument katalogu

Nahrání pluginu (upload_plugin) zapíše jeden dokument do databáze xuda_plugins, klíčovaný názvem balíčku. Ten dokument je zároveň zdrojem instalace (jeho manifest, version a package_source říkají, co stáhnout a co balíček skutečně dodává) a výpisem na tržišti (label, plugin_description, tags, icon, visibility, stat) téhož pluginu. Žádný samostatný záznam výpisu, který by bylo třeba synchronizovat, neexistuje.

Instalace do projektu

Instalace pluginu do projektu (install_plugin) dělá tři věci: nainstaluje balíček přes npm do vlastního node_modules projektu (pod plugins_drive_path, jeden strom na projekt, ne sdílená globální instalace), zaznamená plugin do mapy app_plugins_purchased projektu (installed, version, manifest, plugin_type) a označí projekt jako vyžadující přestavbu (set_update_required_to_app).

Kde kód pluginu skutečně běží

Plugin může dodat kód pro až tři různá místa a spustí se jen tam, kde soubor existuje:

  • V prohlížeči, uvnitř každé publikované aplikace, která má plugin nainstalovaný, přes runtime.mjs. To je fn(plugin_name, element, properties) pluginu UI, volané jednou pro každý prvek, ke kterému je plugin připojen.
  • Na serveru, uvnitř projektu, přes server.mjs. Zde se skutečně implementují methods pluginu typu knihovna a zde plugin dat (dbs) komunikuje se svým úložištěm.
  • Uvnitř samotného Studia při sestavování projektu, přes studio.mjs. Plugin dbs ho používá ke spouštění vlastních živých dotazů proti zobrazení tabulky Studia.

Obrazovka souhlasu s instalací, kterou uživatel vidí před instalací pluginu, se sestavuje přímo podle toho, které z těchto souborů manifest pluginu uvádí, proto je manifest smlouvou pluginu s osobou, která ho instaluje, ne jen artefaktem sestavení.

Dále