Naar de inhoud springen
Geverifieerd

Het pluginmanifest

Zes bestanden die een plugin kan meeleveren, elk een ander startpunt, en het manifest dat vastlegt welke ervan bestaan.

Het manifest van een plugin is geen bestand dat je schrijft. Het wordt door het platform berekend op het moment dat een plugin wordt geüpload: validate_plugin() zoekt op schijf naar precies zes bestandsnamen, legt vast welke bestaan (en of elk in de root van het pakket of onder dist/ is gevonden), en slaat het resultaat op als doc.manifest in het catalogusdocument van de plugin. Alles daarna, de loader van de runtime, het toestemmingsscherm bij installatie, de knop Setup van het dashboard, leest dat manifest in plaats van zelf het pakket te onderzoeken.

De zes bestanden

Een plugin levert mee wat zijn soort nodig heeft. plugins/@xuda.io/xuda-ui-plugin-moment/src heeft alleen index.mjs en runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx heeft index.mjs en server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb heeft index.mjs en server.mjs.

Root of dist/

validate_plugin() zoekt elk bestand eerst in de root van het pakket en dan in dist/<file>. Beide plekken voldoen aan het manifest, dus een plugin die met Vite is gebouwd (de meeste onder plugins/@xuda.io/) levert bron onder src/ mee en laat zijn build de manifestbestanden in dist/ schrijven.

CSS wordt alleen uit dist geladen

runtime.css (en elke andere CSS uit het manifest) wordt alleen opgepikt als de bijbehorende .mjs onder dist/ is gevonden, nooit uit de root van het pakket. De runtime controleert manifest[resource].dist && manifest[resource].css voordat hij de stylesheet ophaalt, dus een plugin met een runtime.mjs en een style.css in de root komt door de validatie (exist: true bij beide) maar de runtime laadt de CSS nooit. Lever via dist/ mee als de plugin zijn stylesheet echt geladen moet hebben.

Waarvoor het manifest wordt gebruikt

  • Een UI-plugin laden. De runtime weigert een UI-plugin helemaal uit te voeren, tenzij het manifest laat zien dat zowel runtime.mjs als index.mjs aanwezig zijn; dan importeert hij index.mjs voor properties, bepaalt hij de waarde van elke eigenschap (inclusief xu-exp:-expressiebindingen) uit de attributen van het element, importeert hij runtime.mjs en roept hij fn aan.
  • Het toestemmingsscherm bij installatie. Aanwezigheid in het manifest wordt direct de zinnen die een gebruiker leest voordat hij installeert: het meeleveren van server.mjs geeft "Runs its own code on Xuda servers, inside your project"; runtime.mjs geeft "Runs its own code inside your published app, in the browser of everyone who uses it"; studio.mjs en setup.mjs krijgen ook een eigen regel.
  • De knop Setup van het dashboard. Het setupscherm van een plugin verschijnt alleen als manifest['index.mjs'].exist waar is en die module niet leeg is, of als de plugin een afhankelijkheid heeft met een eigen setup.