O manifesto do plugin
Seis ficheiros que um plugin pode fornecer, cada um um ponto de entrada diferente, e o manifesto que regista quais deles existem.
O manifesto de um plugin não é um ficheiro que escreve. É calculado pela plataforma no momento em que
um plugin é carregado: validate_plugin() procura em disco exatamente seis nomes de ficheiro, regista
quais existem (e se cada um foi encontrado na raiz do pacote ou em dist/) e guarda o resultado como
doc.manifest no documento de catálogo do plugin. Tudo o que vem depois, o carregador do runtime, o
ecrã de consentimento de instalação, o botão de configuração do painel, lê esse manifesto em vez de
sondar o próprio pacote.
Os seis ficheiros
Um plugin fornece os destes ficheiros de que o seu tipo precisa. plugins/@xuda.io/xuda-ui-plugin-moment/src
tem apenas index.mjs e runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx tem index.mjs e
server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb tem index.mjs e server.mjs.
Raiz ou dist/
validate_plugin() procura cada ficheiro primeiro na raiz do pacote e depois em dist/<file>. Qualquer
localização satisfaz o manifesto, por isso um plugin construído com Vite (a maioria dos que estão em
plugins/@xuda.io/) fornece o código-fonte em src/ e deixa que a sua compilação escreva os ficheiros
do manifesto em dist/.
runtime.css (e qualquer outro CSS do manifesto) só é aproveitado quando o .mjs correspondente foi
encontrado em dist/, nunca na raiz do pacote. O runtime verifica
manifest[resource].dist && manifest[resource].css antes de obter a folha de estilos, por isso um
plugin com um runtime.mjs na raiz e um style.css na raiz passa a validação (exist: true em ambos)
mas o runtime nunca carrega o CSS. Forneça através de dist/ se o plugin precisar que a sua folha de
estilos seja realmente carregada.
Para que serve o manifesto
- Carregar um plugin de interface. O runtime recusa-se a executar um plugin de interface se o
manifesto não mostrar
runtime.mjseindex.mjspresentes; depois importaindex.mjspara obterproperties, resolve o valor de cada propriedade (incluindo as ligações de expressãoxu-exp:) face aos atributos do elemento, importaruntime.mjse chamafn. - O ecrã de consentimento de instalação. A presença no manifesto converte-se diretamente nas frases
que um utilizador lê antes de instalar: fornecer
server.mjsdiz "Executa o seu próprio código nos servidores da Xuda, dentro do seu projeto"; fornecerruntime.mjsdiz "Executa o seu próprio código dentro da sua app publicada, no navegador de todos os que a usam";studio.mjsesetup.mjstambém têm as suas próprias linhas. - O botão Configuração do painel. O ecrã de configuração de um plugin só aparece quando
manifest['index.mjs'].existé verdadeiro e esse módulo não está vazio, ou o plugin tem uma dependência com a sua própria configuração.