O que é um plugin
Um plugin é um pacote npm que se instala num projeto Xuda e o amplia com código executado no navegador, no Studio ou no servidor.
Um plugin Xuda é um pacote npm com âmbito (@xuda.io/<name> para plugins próprios, qualquer âmbito
para terceiros) que um projeto instala para ganhar capacidade: um componente de interface, uma
biblioteca de código chamável a partir do Studio, um socket de base de dados, uma framework de
interface ou um conjunto de ícones. Todos os plugins em plugins/@xuda.io/ neste repositório são um
destes, e a mesma forma serve para um plugin publicado de fora do monorepo.
As peças em movimento
O pacote em disco
Um plugin é um pacote npm normal: package.json mais os ficheiros de manifesto, dos seis possíveis
(ver o manifesto), que fornecer. plugins/@xuda.io/<name> neste repositório
é a cópia de trabalho dos plugins próprios; um terceiro escreve e publica a mesma forma a partir do
seu próprio repositório.
O documento de catálogo
Carregar um plugin (upload_plugin) escreve um documento na base de dados xuda_plugins, indexado
pelo nome do pacote. Esse documento é simultaneamente a fonte de instalação (o seu manifest,
version e package_source indicam o que obter e o que o pacote realmente inclui) e a entrada no
marketplace (label, plugin_description, tags, icon, visibility, stat) do mesmo plugin. Não
há um registo de listagem separado para manter sincronizado.
A instalação no projeto
Instalar um plugin num projeto (install_plugin) faz três coisas: instala o pacote por npm no próprio
node_modules desse projeto (em plugins_drive_path, uma árvore por projeto, não uma instalação
global partilhada), regista o plugin no mapa app_plugins_purchased do projeto (installed, version,
manifest, plugin_type) e assinala que o projeto precisa de ser reconstruído
(set_update_required_to_app).
Onde o código de um plugin é realmente executado
Um plugin pode fornecer código para até três locais diferentes, e só é executado onde o ficheiro existe:
- No navegador, dentro de todas as apps publicadas que têm o plugin instalado, através de
runtime.mjs. É ofn(plugin_name, element, properties)de um plugin de interface, chamado uma vez por elemento a que o plugin está associado. - No servidor, dentro do projeto, através de
server.mjs. É onde osmethodsde um plugin de biblioteca são realmente implementados, e onde um plugin de dados (dbs) comunica com o seu armazenamento. - Dentro do próprio Studio enquanto o projeto está a ser construído, através de
studio.mjs. Um plugindbsusa-o para executar as suas próprias consultas em direto na vista de tabelas do Studio.
O ecrã de consentimento de instalação que um utilizador vê antes de instalar um plugin é construído diretamente a partir de quais destes ficheiros o manifesto do plugin diz fornecer, e é por isso que o manifesto é o contrato do plugin com quem o instala, e não apenas um artefacto de compilação.