Preskočiť na obsah
Overené

Čo je plugin

Plugin je balík npm, ktorý sa nainštaluje do jedného projektu Xuda a rozširuje ho kódom, ktorý beží v prehliadači, v Studiu alebo na serveri.

Plugin Xuda je balík npm s rozsahom (@xuda.io/<name> pre pluginy od prvej strany, ľubovoľný rozsah pre tretiu stranu), ktorý projekt nainštaluje, aby získal schopnosť: komponent UI, knižnicu kódu volateľnú zo Studia, databázovú zásuvku, UI framework alebo sadu ikon. Každý plugin v plugins/@xuda.io/ v tomto repozitári je takýto a rovnaký tvar funguje pre plugin zverejnený mimo monorepa.

The moving pieces

The package on disk

Plugin je bežný balík npm: package.json plus ktorýkoľvek zo šiestich súborov manifestu (pozri manifest), ktoré dodáva. plugins/@xuda.io/<name> v tomto repozitári je pracovná kópia pluginov od prvej strany; tretia strana píše a zverejňuje rovnaký tvar zo svojho vlastného repozitára.

The catalog document

Nahranie pluginu (upload_plugin) zapíše jeden dokument do databázy xuda_plugins, indexovaný názvom balíka. Tento dokument je zároveň zdrojom inštalácie (jeho manifest, version a package_source hovoria, čo stiahnuť a čo balík skutočne dodáva) aj záznamom v marketplace (label, plugin_description, tags, icon, visibility, stat) pre ten istý plugin. Neexistuje samostatný záznam zoznamu, ktorý by bolo treba udržiavať zosúladený.

The project install

Inštalácia pluginu do projektu (install_plugin) robí tri veci: nainštaluje balík cez npm do vlastného node_modules projektu (pod plugins_drive_path, jeden strom na projekt, nie zdieľaná globálna inštalácia), zapíše plugin do mapy app_plugins_purchased projektu (installed, version, manifest, plugin_type) a označí projekt ako vyžadujúci prestavbu (set_update_required_to_app).

Where a plugin's code actually runs

Plugin môže dodať kód pre až tri rôzne miesta a beží len tam, kde súbor existuje:

  • V prehliadači, vo vnútri každej zverejnenej aplikácie, ktorá má plugin nainštalovaný, cez runtime.mjs. To je fn(plugin_name, element, properties) pluginu UI, volané raz pre každý prvok, ku ktorému je plugin pripojený.
  • Na serveri, vo vnútri projektu, cez server.mjs. Tam sa skutočne implementujú methods pluginu typu library a tam plugin dát (dbs) komunikuje so svojím úložiskom.
  • Vo vnútri samotného Studia počas zostavovania projektu, cez studio.mjs. Plugin dbs to používa na spúšťanie vlastných živých dotazov nad pohľadom tabuľky Studia.

Obrazovka so súhlasom pri inštalácii, ktorú používateľ vidí pred inštaláciou pluginu, sa zostavuje priamo z toho, ktoré z týchto súborov manifest pluginu uvádza, preto je manifest zmluvou pluginu s osobou, ktorá ho inštaluje, a nielen artefaktom zostavenia.

Next