Ugrás a tartalomhoz
Ellenőrizve

Mi a bővítmény

A bővítmény egy npm csomag, amely egyetlen Xuda projektbe települ, és olyan kóddal bővíti, amely a böngészőben, a Studióban vagy a szerveren fut.

A Xuda bővítmény egy hatókörös npm csomag (@xuda.io/<name> az elsődleges gyártói bővítményeknél, bármely hatókör harmadik félnél), amelyet egy projekt telepít, hogy képességgel bővüljön: felületi komponens, a Studióból hívható kódkönyvtár, adatbázis-csatlakozó, UI-keretrendszer vagy ikonkészlet. Ebben a tárolóban a plugins/@xuda.io/ alatti minden bővítmény ilyen, és ugyanez az alak működik a monorepón kívülről publikált bővítménynél is.

A mozgó alkatrészek

A csomag a lemezen

A bővítmény egy normál npm csomag: a package.json plusz a hat manifestfájl (lásd a manifestet) közül azok, amelyeket szállít. A plugins/@xuda.io/<name> ebben a tárolóban az elsődleges gyártói bővítmények munkapéldánya; egy harmadik fél ugyanezt az alakot írja és publikálja a saját tárolójából.

A katalógusdokumentum

A bővítmény feltöltése (upload_plugin) egyetlen dokumentumot ír az xuda_plugins adatbázisba, a csomag nevével kulcsolva. Ez a dokumentum egyszerre a telepítési forrás (a manifest, version és package_source mondja meg, mit kell letölteni és mit szállít a csomag valójában) és a piactéri listázás (label, plugin_description, tags, icon, visibility, stat) ugyanahhoz a bővítményhez. Nincs külön listázási rekord, amelyet szinkronban kellene tartani.

A projektbe telepítés

A bővítmény projektbe telepítése (install_plugin) három dolgot csinál: npm-mel telepíti a csomagot a projekt saját node_modules mappájába (a plugins_drive_path alatt, projektenként egy fa, nem megosztott globális telepítés), rögzíti a bővítményt a projekt app_plugins_purchased térképében (telepítve, verzió, manifest, plugin_type), és megjelöli a projektet, hogy újraépítésre szorul (set_update_required_to_app).

Hol fut valójában a bővítmény kódja

A bővítmény legfeljebb három különböző helyre szállíthat kódot, és csak ott fut, ahol a fájl létezik:

  • A böngészőben, minden publikált alkalmazásban, amelybe a bővítmény telepítve van, a runtime.mjs révén. Ez egy UI bővítmény fn(plugin_name, element, properties) függvénye, amelyet minden elemhez egyszer hív, amelyhez a bővítmény csatolva van.
  • A szerveren, a projekten belül, a server.mjs révén. Itt valósulnak meg ténylegesen egy könyvtárbővítmény methods metódusai, és itt kommunikál egy adat (dbs) bővítmény a háttértárával.
  • Magában a Studióban, a projekt építése közben, a studio.mjs révén. Egy dbs bővítmény ezt használja, hogy saját élő lekérdezéseket futtasson a Studio táblanézete ellen.

A telepítési hozzájáruló képernyő, amelyet a felhasználó a bővítmény telepítése előtt lát, közvetlenül abból épül fel, hogy a bővítmény manifestje szerint ezek közül mely fájlokat szállítja, ezért a manifest a bővítmény szerződése a telepítővel, nem csupán építési melléktermék.

Következő