Czym jest wtyczka
Wtyczka to pakiet npm, który instaluje się w jednym projekcie Xuda i rozszerza go kodem działającym w przeglądarce, w Studio lub na serwerze.
Wtyczka Xuda to pakiet npm w zakresie nazw (@xuda.io/<name> dla wtyczek własnych, dowolny zakres
dla zewnętrznych), który projekt instaluje, żeby dodać możliwość: komponent UI, bibliotekę kodu
wywoływalną ze Studio, gniazdo bazy danych, framework UI albo zestaw ikon. Każda wtyczka w
plugins/@xuda.io/ w tym repozytorium jest taka, a ten sam kształt działa dla wtyczki
opublikowanej spoza monorepo.
Ruchome elementy
Pakiet na dysku
Wtyczka to zwykły pakiet npm: package.json plus te z sześciu plików manifestu (zobacz
manifest), które dostarcza. plugins/@xuda.io/<name> w tym repozytorium
to kopia robocza wtyczek własnych; strona trzecia pisze i publikuje ten sam kształt z własnego
repozytorium.
Dokument katalogu
Przesłanie wtyczki (upload_plugin) zapisuje jeden dokument w bazie xuda_plugins, kluczowany
nazwą pakietu. Ten dokument jest zarówno źródłem instalacji (jego manifest, version i
package_source mówią, co pobrać i co pakiet faktycznie dostarcza), jak i wpisem w marketplace
(label, plugin_description, tags, icon, visibility, stat) dla dokładnie tej samej
wtyczki. Nie ma osobnego rekordu wpisu do synchronizowania.
Instalacja w projekcie
Zainstalowanie wtyczki w projekcie (install_plugin) robi trzy rzeczy: instaluje pakiet przez npm do
własnego node_modules tego projektu (w plugins_drive_path, jedno drzewo na projekt, a nie
współdzielona instalacja globalna), zapisuje wtyczkę w mapie app_plugins_purchased projektu
(zainstalowana, wersja, manifest, plugin_type) i oznacza projekt jako wymagający przebudowania
(set_update_required_to_app).
Gdzie faktycznie działa kod wtyczki
Wtyczka może dostarczyć kod na maksymalnie trzy różne miejsca i działa on tylko tam, gdzie plik istnieje:
- W przeglądarce, w każdej opublikowanej aplikacji z zainstalowaną wtyczką, przez
runtime.mjs. Tofn(plugin_name, element, properties)wtyczki UI, wywoływane raz dla każdego elementu, do którego wtyczka jest podpięta. - Na serwerze, w projekcie, przez
server.mjs. Tu faktycznie zaimplementowane sąmethodswtyczki biblioteki i tu wtyczka danych (dbs) rozmawia ze swoim magazynem. - Wewnątrz samego Studio podczas budowania projektu, przez
studio.mjs. Wtyczkadbsużywa tego do uruchamiania własnych zapytań na żywo względem widoku tabeli Studio.
Ekran zgody na instalację, który użytkownik widzi przed zainstalowaniem wtyczki, jest budowany bezpośrednio z tego, które z tych plików manifest wtyczki deklaruje jako dostarczane, dlatego manifest jest umową wtyczki z osobą, która ją instaluje, a nie tylko artefaktem budowania.