Naar de inhoud springen
Geverifieerd

Wat een plugin is

Een plugin is een npm-pakket dat je in één Xuda-project installeert en dat het uitbreidt met code die in de browser, in Studio of op de server draait.

Een Xuda-plugin is een npm-pakket met scope (@xuda.io/<name> voor first-party plugins, elke scope voor een externe partij) dat een project installeert om er een mogelijkheid aan toe te voegen: een UI-component, een codebibliotheek die je vanuit Studio kunt aanroepen, een databasesocket, een UI-framework of een iconenset. Elke plugin onder plugins/@xuda.io/ in deze repo is er een, en dezelfde vorm werkt voor een plugin die van buiten de monorepo wordt gepubliceerd.

De onderdelen

Het pakket op schijf

Een plugin is een gewoon npm-pakket: package.json plus welke van de zes manifestbestanden (zie het manifest) hij meelevert. plugins/@xuda.io/<name> in deze repo is de werkkopie voor de first-party plugins; een externe partij schrijft en publiceert dezelfde vorm vanuit de eigen repo.

Het catalogusdocument

Een plugin uploaden (upload_plugin) schrijft één document naar de database xuda_plugins, met de pakketnaam als sleutel. Dat document is zowel de installatiebron (zijn manifest, version en package_source zeggen wat er moet worden opgehaald en wat het pakket echt meelevert) als de marketplacevermelding (label, plugin_description, tags, icon, visibility, stat) voor precies dezelfde plugin. Er is geen apart vermeldingsrecord dat je synchroon moet houden.

De projectinstallatie

Een plugin in een project installeren (install_plugin) doet drie dingen: het npm-installeert het pakket in de eigen node_modules van dat project (onder plugins_drive_path, één boom per project, geen gedeelde globale installatie), het legt de plugin vast onder de map app_plugins_purchased van het project (geïnstalleerd, versie, manifest, plugin_type), en het markeert het project als herbouw-nodig (set_update_required_to_app).

Waar de code van een plugin echt draait

Een plugin kan code meeleveren voor maximaal drie verschillende plekken, en hij draait alleen waar het bestand bestaat:

  • In de browser, in elke gepubliceerde app waarin de plugin is geïnstalleerd, via runtime.mjs. Dit is de fn(plugin_name, element, properties) van een UI-plugin, één keer aangeroepen per element waaraan de plugin is gekoppeld.
  • Op de server, binnen het project, via server.mjs. Hier worden de methods van een bibliotheekplugin echt geïmplementeerd, en hier praat een data-plugin (dbs) met zijn opslag.
  • In Studio zelf terwijl het project wordt gebouwd, via studio.mjs. Een dbs-plugin gebruikt dit om zijn eigen live queries uit te voeren op de tabelweergave in Studio.

Het toestemmingsscherm dat een gebruiker ziet voordat hij een plugin installeert, wordt rechtstreeks opgebouwd uit welke van deze bestanden het manifest van de plugin zegt mee te leveren. Daarom is het manifest het contract van de plugin met de persoon die hem installeert, en niet alleen een buildartefact.

Volgende stap