Saltar al contenido
Verificada

El manifiesto del plugin

Seis archivos que puede incluir un plugin, cada uno un punto de entrada distinto, y el manifiesto que registra cuáles existen.

El manifiesto de un plugin no es un archivo que escribas. Lo calcula la plataforma en el momento de subir un plugin: validate_plugin() busca en disco exactamente seis nombres de archivo, registra cuáles existen (y si cada uno se encontró en la raíz del paquete o bajo dist/) y guarda el resultado como doc.manifest en el documento de catálogo del plugin. Todo lo que viene después, el cargador del runtime, la pantalla de consentimiento de instalación, el botón de configuración del dashboard, lee ese manifiesto en lugar de examinar el propio paquete.

Los seis archivos

Un plugin incluye los que necesite su tipo. plugins/@xuda.io/xuda-ui-plugin-moment/src solo tiene index.mjs y runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx tiene index.mjs y server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb tiene index.mjs y server.mjs.

Raíz o dist/

validate_plugin() busca cada archivo primero en la raíz del paquete y luego en dist/<file>. Cualquiera de las dos ubicaciones satisface el manifiesto, así que un plugin compilado con Vite (la mayoría de los de plugins/@xuda.io/) incluye el código fuente en src/ y deja que su compilación escriba los archivos del manifiesto en dist/.

El CSS solo se carga desde dist

runtime.css (y cualquier otro CSS del manifiesto) solo se recoge cuando su .mjs correspondiente se encontró bajo dist/, nunca desde la raíz del paquete. El runtime comprueba manifest[resource].dist && manifest[resource].css antes de descargar la hoja de estilos, así que un plugin con un runtime.mjs en la raíz y un style.css en la raíz pasa la validación (exist: true en ambos) pero el runtime nunca carga el CSS. Publica a través de dist/ si el plugin necesita que su hoja de estilos se cargue de verdad.

Para qué se usa el manifiesto

  • Cargar un plugin de interfaz. El runtime se niega a ejecutar un plugin de interfaz a menos que el manifiesto muestre que existen tanto runtime.mjs como index.mjs; entonces importa index.mjs para obtener properties, resuelve el valor de cada propiedad (incluidos los enlaces de expresión xu-exp:) contra los atributos del elemento, importa runtime.mjs y llama a fn.
  • La pantalla de consentimiento de instalación. La presencia en el manifiesto se convierte directamente en las frases que lee un usuario antes de instalar: incluir server.mjs dice "Runs its own code on Xuda servers, inside your project"; incluir runtime.mjs dice "Runs its own code inside your published app, in the browser of everyone who uses it"; studio.mjs y setup.mjs también tienen su propia línea.
  • El botón Setup del dashboard. La pantalla de configuración de un plugin solo se muestra cuando manifest['index.mjs'].exist es verdadero y ese módulo no está vacío, o cuando el plugin tiene una dependencia con su propia configuración.