Gå til indhold
Bekræftet

Hvad et plugin er

Et plugin er en npm-pakke, der installeres i ét Xuda-projekt og udvider det med kode, der kører i browseren, i Studio eller på serveren.

Et Xuda-plugin er en npm-pakke med scope (@xuda.io/<name> for førsteparts-plugins, et vilkårligt scope for en tredjepart), som et projekt installerer for at tilføje funktionalitet: en UI-komponent, et kodebibliotek, der kan kaldes fra Studio, en databasesokkel, et UI-framework eller et ikonsæt. Hvert plugin under plugins/@xuda.io/ i dette repo er et, og den samme form virker for et plugin udgivet uden for monorepoet.

De bevægelige dele

Pakken på disken

Et plugin er en almindelig npm-pakke: package.json plus de af de seks manifestfiler (se manifestet), den leverer. plugins/@xuda.io/<name> i dette repo er arbejdskopien for førsteparts-plugins; en tredjepart skriver og udgiver den samme form fra sit eget repo.

Katalogdokumentet

Når et plugin uploades (upload_plugin), skrives ét dokument til databasen xuda_plugins, nøglet på pakkenavnet. Det dokument er både installationskilden (dets manifest, version og package_source angiver, hvad der skal hentes, og hvad pakken faktisk leverer) og markedspladsens opslag (label, plugin_description, tags, icon, visibility, stat) for præcis det samme plugin. Der er ingen separat opslagspost, der skal holdes synkroniseret.

Projektinstallationen

Når et plugin installeres i et projekt (install_plugin), sker der tre ting: pakken npm-installeres i projektets egen node_modules (under plugins_drive_path, ét træ pr. projekt, ikke en delt global installation), plugin'et registreres i projektets app_plugins_purchased- map (installeret, version, manifest, plugin_type), og projektet markeres som værende i behov af en ny build (set_update_required_to_app).

Hvor et plugins kode faktisk kører

Et plugin kan levere kode til op til tre forskellige steder, og den kører kun, hvor filen findes:

  • I browseren, i hver udgivet app, der har plugin'et installeret, via runtime.mjs. Det er et UI-plugins fn(plugin_name, element, properties), kaldt én gang for hvert element, plugin'et er knyttet til.
  • På serveren, inde i projektet, via server.mjs. Det er her, et biblioteksplugins methods faktisk er implementeret, og hvor et data-plugin (dbs) taler med sit lager.
  • Inde i selve Studio, mens projektet bygges, via studio.mjs. Et dbs-plugin bruger den til at køre sine egne live-forespørgsler mod Studio-tabelvisningen.

Samtykkeskærmen, en bruger ser, før et plugin installeres, bygges direkte ud fra, hvilke af disse filer plugin'ets manifest siger, det leverer, hvilket er grunden til, at manifestet er plugin'ets kontrakt med den, der installerer det, ikke blot et build-artefakt.

Næste