Hoppa till innehållet
Verifierad

Vad en plugin är

En plugin är ett npm-paket som installeras i ett Xuda-projekt och utökar det med kod som körs i webbläsaren, i Studio eller på servern.

En Xuda-plugin är ett npm-paket med omfång (@xuda.io/<name> för förstapartsplugins, valfritt omfång för tredje part) som ett projekt installerar för att få en ny förmåga: en UI-komponent, ett kodbibliotek som kan anropas från Studio, ett databasuttag, ett UI-ramverk eller en ikonuppsättning. Varje plugin under plugins/@xuda.io/ i den här kodbasen är en sådan, och samma form fungerar för en plugin som publiceras utanför monorepot.

Delarna som rör sig

Paketet på disk

En plugin är ett vanligt npm-paket: package.json plus de av de sex manifestfilerna (se manifestet) som den levererar. plugins/@xuda.io/<name> i den här kodbasen är arbetskopian för förstapartsplugins; en tredje part skriver och publicerar samma form från sin egen repo.

Katalogdokumentet

Att ladda upp en plugin (upload_plugin) skriver ett dokument till databasen xuda_plugins, nycklat på paketnamnet. Det dokumentet är både installationskällan (dess manifest, version och package_source säger vad som ska hämtas och vad paketet faktiskt innehåller) och marknadsplatsens post (label, plugin_description, tags, icon, visibility, stat) för exakt samma plugin. Det finns ingen separat listpost att hålla synkroniserad.

Projektinstallationen

Att installera en plugin i ett projekt (install_plugin) gör tre saker: den npm-installerar paketet i projektets egen node_modules (under plugins_drive_path, ett träd per projekt, inte en delad global installation), den registrerar pluginen under projektets app_plugins_purchased-karta (installed, version, manifest, plugin_type), och den markerar projektet som i behov av en ombyggnad (set_update_required_to_app).

Var en plugins kod faktiskt körs

En plugin kan leverera kod för upp till tre olika platser, och den körs bara där filen finns:

  • I webbläsaren, inuti varje publicerad app som har pluginen installerad, via runtime.mjs. Det här är en UI-plugins fn(plugin_name, element, properties), som anropas en gång per element som pluginen är kopplad till.
  • På servern, inuti projektet, via server.mjs. Det är här ett biblioteksplugins methods faktiskt implementeras, och där en data-plugin (dbs) pratar med sitt lagringsställe.
  • Inuti själva Studio medan projektet byggs, via studio.mjs. En dbs-plugin använder det här för att köra sina egna live-frågor mot Studios tabellvy.

Skärmen för godkännande vid installation som en användare ser innan en plugin installeras byggs direkt utifrån vilka av de här filerna pluginens manifest säger att den levererar, och därför är manifestet pluginens kontrakt med den som installerar den, inte bara en byggartefakt.

Nästa