Qué es un plugin
Un plugin es un paquete npm que se instala en un proyecto de Xuda y lo amplía con código que se ejecuta en el navegador, en Studio o en el servidor.
Un plugin de Xuda es un paquete npm con ámbito (@xuda.io/<name> para los plugins propios, cualquier ámbito para un tercero) que un proyecto instala para añadir capacidad: un componente de interfaz, una librería de código invocable desde Studio, un socket de base de datos, un framework de interfaz o un conjunto de iconos. Todos los plugins de plugins/@xuda.io/ de este repositorio lo son, y la misma estructura sirve para un plugin publicado desde fuera del monorepo.
Las piezas en juego
El paquete en disco
Un plugin es un paquete npm normal: package.json más los archivos de los seis posibles archivos de manifiesto (consulta el manifiesto) que incluya. plugins/@xuda.io/<name> en este repositorio es la copia de trabajo de los plugins propios; un tercero escribe y publica la misma estructura desde su propio repositorio.
El documento del catálogo
Subir un plugin (upload_plugin) escribe un documento en la base de datos xuda_plugins, identificado por el nombre del paquete. Ese documento es a la vez el origen de instalación (su manifest, version y package_source indican qué descargar y qué incluye realmente el paquete) y la ficha del marketplace (label, plugin_description, tags, icon, visibility, stat) del mismo plugin. No hay ningún registro de ficha aparte que mantener sincronizado.
La instalación en el proyecto
Instalar un plugin en un proyecto (install_plugin) hace tres cosas: instala el paquete con npm en el node_modules propio de ese proyecto (bajo plugins_drive_path, un árbol por proyecto, no una instalación global compartida), registra el plugin en el mapa app_plugins_purchased del proyecto (instalado, versión, manifiesto, plugin_type) y marca el proyecto como pendiente de recompilación (set_update_required_to_app).
Dónde se ejecuta realmente el código de un plugin
Un plugin puede incluir código para hasta tres lugares distintos, y solo se ejecuta donde existe el archivo:
- En el navegador, dentro de cada app publicada que tiene el plugin instalado, mediante
runtime.mjs. Es elfn(plugin_name, element, properties)de un plugin de interfaz, que se llama una vez por cada elemento al que está asociado el plugin. - En el servidor, dentro del proyecto, mediante
server.mjs. Es donde se implementan realmente losmethodsde un plugin de librería, y donde un plugin de datos (dbs) habla con su almacén de respaldo. - Dentro del propio Studio mientras se construye el proyecto, mediante
studio.mjs. Un plugindbslo usa para ejecutar sus propias consultas en vivo sobre la vista de tabla de Studio.
La pantalla de consentimiento de instalación que ve un usuario antes de instalar un plugin se construye directamente a partir de cuáles de estos archivos dice el manifiesto del plugin que incluye, por eso el manifiesto es el contrato del plugin con la persona que lo instala, no solo un artefacto de compilación.