Sari la conținut
Verificat

Ce este un plugin

Un plugin este un pachet npm care se instalează într-un proiect Xuda și îl extinde cu cod care rulează în browser, în Studio sau pe server.

Un plugin Xuda este un pachet npm cu domeniu (@xuda.io/<name> pentru plugin-urile first-party, orice domeniu pentru un terț) pe care un proiect îl instalează ca să adauge o capacitate: o componentă de UI, o bibliotecă de cod apelabilă din Studio, un socket de bază de date, un framework de UI sau un set de pictograme. Fiecare plugin din plugins/@xuda.io/ din acest repo este unul, iar aceeași formă funcționează pentru un plugin publicat din afara monorepo-ului.

Piesele în mișcare

Pachetul de pe disc

Un plugin este un pachet npm obișnuit: package.json plus oricare dintre cele șase fișiere de manifest (vezi manifestul) pe care le livrează. plugins/@xuda.io/<name> din acest repo este copia de lucru pentru plugin-urile first-party; un terț scrie și publică aceeași formă din propriul repo.

Documentul din catalog

Încărcarea unui plugin (upload_plugin) scrie un document în baza de date xuda_plugins, indexat după numele pachetului. Acel document este atât sursa de instalare (manifest, version și package_source spun ce să descarce și ce livrează de fapt pachetul), cât și intrarea din marketplace (label, plugin_description, tags, icon, visibility, stat) pentru exact același plugin. Nu există o înregistrare de listare separată de ținut sincronizată.

Instalarea în proiect

Instalarea unui plugin într-un proiect (install_plugin) face trei lucruri: instalează pachetul cu npm în propriul node_modules al proiectului (sub plugins_drive_path, un arbore pe proiect, nu o instalare globală comună), înregistrează pluginul în harta app_plugins_purchased a proiectului (instalat, versiune, manifest, plugin_type) și marchează proiectul ca având nevoie de reconstruire (set_update_required_to_app).

Unde rulează de fapt codul unui plugin

Un plugin poate livra cod pentru până la trei locuri diferite și rulează doar acolo unde fișierul există:

  • În browser, în fiecare aplicație publicată care are pluginul instalat, prin runtime.mjs. Aceasta este fn(plugin_name, element, properties) al unui plugin de UI, apelat o dată pentru fiecare element la care este atașat pluginul.
  • Pe server, în interiorul proiectului, prin server.mjs. Aici sunt implementate de fapt methods ale unui plugin de bibliotecă și aici vorbește un plugin de date (dbs) cu stocarea lui.
  • În Studio însuși cât timp proiectul este construit, prin studio.mjs. Un plugin dbs îl folosește ca să ruleze propriile interogări live în vizualizarea de tabel din Studio.

Ecranul de consimțământ la instalare pe care îl vede un utilizator înainte să instaleze un plugin este construit direct din ce fișiere spune manifestul pluginului că livrează, motiv pentru care manifestul este contractul pluginului cu persoana care îl instalează, nu doar un artefact de build.

Urmează