Hopp til innholdet
Bekreftet

Hva en plugin er

En plugin er en npm-pakke som installeres i ett Xuda-prosjekt og utvider det med kode som kjører i nettleseren, i Studio eller på serveren.

En Xuda-plugin er en npm-pakke med scope (@xuda.io/<name> for førsteparts plugins, hvilket som helst scope for en tredjepart) som et prosjekt installerer for å få ny funksjonalitet: en UI-komponent, et kodebibliotek som kan kalles fra Studio, en databasekontakt, et UI-rammeverk eller et ikonsett. Hver plugin under plugins/@xuda.io/ i dette depotet er en, og den samme formen fungerer for en plugin publisert utenfra monorepoet.

Delene som henger sammen

Pakken på disk

En plugin er en vanlig npm-pakke: package.json pluss de av de seks manifestfilene (se manifestet) den leverer. plugins/@xuda.io/<name> i dette depotet er arbeidskopien for førsteparts plugins. En tredjepart skriver og publiserer den samme formen fra sitt eget depot.

Katalogdokumentet

Å laste opp en plugin (upload_plugin) skriver ett dokument til xuda_plugins-databasen, med pakkenavnet som nøkkel. Det dokumentet er både installasjonskilden (dets manifest, version og package_source sier hva som skal hentes og hva pakken faktisk leverer) og markedsplassoppføringen (label, plugin_description, tags, icon, visibility, stat) for akkurat den samme pluginen. Det er ingen egen oppføring som må holdes synkronisert.

Prosjektinstallasjonen

Å installere en plugin i et prosjekt (install_plugin) gjør tre ting: den npm-installerer pakken i prosjektets egen node_modules (under plugins_drive_path, ett tre per prosjekt, ikke en delt global installasjon), den registrerer pluginen i prosjektets app_plugins_purchased-oversikt (installert, versjon, manifest, plugin_type), og den flagger prosjektet som at det trenger en ny bygging (set_update_required_to_app).

Hvor en plugins kode faktisk kjører

En plugin kan levere kode for opptil tre ulike steder, og den kjører bare der filen finnes:

  • I nettleseren, inni hver publiserte app som har pluginen installert, via runtime.mjs. Dette er en UI-plugins fn(plugin_name, element, properties), kalt én gang per element pluginen er knyttet til.
  • På serveren, inni prosjektet, via server.mjs. Her er et biblioteks-plugins methods faktisk implementert, og her snakker en data-plugin (dbs) med lagringen sin.
  • Inni selve Studio mens prosjektet bygges, via studio.mjs. En dbs-plugin bruker denne til å kjøre sine egne live-spørringer mot Studios tabellvisning.

Samtykkeskjermen en bruker ser før en plugin installeres, bygges direkte ut fra hvilke av disse filene pluginens manifest sier den leverer, og det er derfor manifestet er pluginens kontrakt med personen som installerer den, ikke bare et byggeresultat.

Neste