Zum Inhalt springen
Geprüft

Was ein Plugin ist

Ein Plugin ist ein npm-Paket, das in ein Xuda-Projekt installiert wird und es mit Code erweitert, der im Browser, in Studio oder auf dem Server läuft.

Ein Xuda-Plugin ist ein npm-Paket mit Scope (@xuda.io/<name> für First-Party-Plugins, ein beliebiger Scope für Drittanbieter), das ein Projekt installiert, um Fähigkeiten hinzuzufügen: eine UI-Komponente, eine Code-Bibliothek, die aus Studio aufrufbar ist, einen Datenbank-Socket, ein UI-Framework oder ein Icon-Set. Jedes Plugin unter plugins/@xuda.io/ in diesem Repo ist eines, und dieselbe Form funktioniert für ein Plugin, das von außerhalb des Monorepos veröffentlicht wird.

Die einzelnen Bestandteile

Das Paket auf der Festplatte

Ein Plugin ist ein normales npm-Paket: package.json plus die Manifest-Dateien (von sechs möglichen, siehe das Manifest), die es mitliefert. plugins/@xuda.io/<name> in diesem Repo ist die Arbeitskopie der First-Party-Plugins. Ein Drittanbieter schreibt und veröffentlicht dieselbe Form aus seinem eigenen Repo.

Das Katalogdokument

Das Hochladen eines Plugins (upload_plugin) schreibt ein Dokument in die Datenbank xuda_plugins, geschlüsselt nach dem Paketnamen. Dieses Dokument ist sowohl die Installationsquelle (sein manifest, version und package_source sagen, was geholt werden soll und was das Paket tatsächlich mitliefert) als auch der Marketplace- Eintrag (label, plugin_description, tags, icon, visibility, stat) für genau dasselbe Plugin. Es gibt keinen separaten Eintragsdatensatz, den man synchron halten müsste.

Die Projektinstallation

Das Installieren eines Plugins in ein Projekt (install_plugin) tut drei Dinge: Es installiert das Paket per npm in das eigene node_modules dieses Projekts (unter plugins_drive_path, ein Baum pro Projekt, keine gemeinsame globale Installation), es trägt das Plugin in die app_plugins_purchased-Map des Projekts ein (installed, version, manifest, plugin_type), und es markiert das Projekt als neu zu bauen (set_update_required_to_app).

Wo der Code eines Plugins tatsächlich läuft

Ein Plugin kann Code für bis zu drei verschiedene Orte mitliefern, und er läuft nur dort, wo die Datei existiert:

  • Im Browser, in jeder veröffentlichten App, in der das Plugin installiert ist, über runtime.mjs. Das ist das fn(plugin_name, element, properties) eines UI-Plugins, einmal pro Element aufgerufen, an das das Plugin angehängt ist.
  • Auf dem Server, innerhalb des Projekts, über server.mjs. Hier werden die methods eines Bibliotheks-Plugins tatsächlich implementiert, und hier spricht ein Daten-Plugin (dbs) mit seinem Speicher.
  • In Studio selbst, während das Projekt gebaut wird, über studio.mjs. Ein dbs-Plugin nutzt das, um seine eigenen Live-Abfragen in der Studio-Tabellenansicht auszuführen.

Die Zustimmungsseite, die ein Benutzer vor dem Installieren eines Plugins sieht, wird direkt daraus aufgebaut, welche dieser Dateien das Manifest des Plugins als mitgeliefert angibt. Deshalb ist das Manifest der Vertrag des Plugins mit der Person, die es installiert, und nicht nur ein Build-Artefakt.

Weiter