Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Brasil)
Esta página foi traduzida automaticamente. Leia o original em inglês.

Esquema do socket Wasm annotation-transform do Aggrega

Referência gerada. Não edite à mão — gere novamente a partir do JSON Schema publicado.

ID do esquema: https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json

As formas de transmissão que um plugin de governança vinculado no papel annotation-transform consome (AnnotationTransformInput) e emite (AnnotationTransformOutput). O papel é executado após a resolução e antes da expansão de anotações: o plugin lê os destinos de injeção resolvidos e as chaves de associação registradas do Manifest, e retorna uma lista de injeções de anotações que o host aplica a esses destinos antes que a expansão transforme as anotações associadas em vinculações de Feature. Os tipos de payload de Go, Rust e TypeScript são gerados a partir deste esquema nos pacotes da ABI de plugins, de modo que as três linguagens leem e escrevem o mesmo formato de transmissão; um guest os importa desses pacotes, ou por meio do seu kit de plugins quando o kit os reexporta.

Uma das seguintes formas

  • AnnotationTransformInput
  • AnnotationTransformOutput

Definições

AnnotationTransformInput

O payload que o host entrega ao plugin annotation-transform a cada invocação: os destinos de injeção resolvidos com as suas anotações atuais, as chaves de associação de anotações registradas do Manifest, e as próprias origens fixadas e configurações da vinculação.

PropriedadeTipoObrigatóriaDescrição
targetsAnnotationTarget[]simOs destinos de injeção — os componentes resolvidos nos quais o plugin pode injetar anotações, cada um com o seu conjunto de anotações atual, para que o plugin possa decidir o que adicionar sem sobrescrever uma chave existente. Ordenados de forma determinística pelo host.
binding_keysstring[]simAs chaves de anotação para as quais o Manifest registra uma associação, na ordem do autor. Uma injeção cuja chave está registrada se expande em uma vinculação de Feature; o plugin lê esta lista para injetar apenas chaves que serão associadas. O host não exige que uma injeção nomeie uma chave registrada — uma anotação injetada não registrada se comporta exatamente como uma anotação não associada escrita por um autor.
sourcesAnnotationSource[]nãoArquivos de definição que o host lê e entrega literalmente ao plugin, como uma lista ordenada por caminho. O host lê os bytes como conteúdo opaco e não os analisa. Ausente quando a vinculação não declara origens.
settingsobjectnãoUm objeto de configurações de formato livre que o host entrega literalmente ao plugin. O host não analisa o seu conteúdo nem age com base nele. Ausente quando a vinculação não declara configurações.

Não são permitidas propriedades adicionais.

AnnotationTransformOutput

A forma de resposta que o plugin annotation-transform emite: uma lista de injeções de anotações que o host aplica aos destinos nomeados. O host aplica apenas adições de anotações a coordenadas de destino existentes, cada uma com um valor que um autor poderia escrever nessa anotação — uma string, ou um objeto de subchaves; uma injeção que nomeia uma coordenada inexistente, ou que carrega um valor de qualquer outra forma, interrompe o build de forma explícita.

PropriedadeTipoObrigatóriaDescrição
injectionsAnnotationInjection[]simInjeções de anotações a aplicar, em ordem. Cada uma nomeia uma coordenada de destino existente e a chave e o valor de anotação a adicionar ali.
errorstringnãoUma mensagem de falha definida quando o guest foi executado, mas não conseguiu concluir a operação; ausente em caso de sucesso. O host apresenta um erro presente como uma invocação de plugin com falha.

Não são permitidas propriedades adicionais.

AnnotationTarget

Um destino de injeção resolvido no qual o plugin pode injetar anotações: o seu caminho de fronteira e o nome do componente, e o conjunto de anotações que o componente já carrega.

PropriedadeTipoObrigatóriaDescrição
boundary_pathstringsimO caminho de fronteira separado por barras sob o qual o componente se encontra na Release.
component_namestringsimO nome do componente dentro da sua fronteira.
annotationsmapa de string ou object ou nullsimAs anotações que a Release escreve no próprio componente, indexadas por chave de anotação na ordem em que estão escritas. Cada valor é o que o autor escreveu: uma string, um objeto de subchaves na sua própria ordem de escrita, ou null onde o componente renuncia a uma anotação que de outro modo herdaria. Toda chave está presente qualquer que seja o seu valor, de modo que um plugin consegue distinguir uma anotação que o componente já carrega de uma que ele não carrega e adicionar apenas o que falta.

Não são permitidas propriedades adicionais.

AnnotationInjection

Uma anotação a injetar em um destino: a coordenada do destino mais a chave da anotação e o seu valor.

PropriedadeTipoObrigatóriaDescrição
boundary_pathstringsimO caminho de fronteira separado por barras do componente de destino. Deve nomear um destino que o host forneceu; uma coordenada desconhecida interrompe o build.
component_namestringsimO nome do componente de destino. Deve nomear um destino que o host forneceu; uma coordenada desconhecida interrompe o build.
annotation_keystringsimA chave de anotação a adicionar no componente de destino.
annotation_valuestring ou objectsimO valor da anotação, carregado como o seu JSON: uma string, ou um objeto cujas chaves são subchaves e cujas entradas são o que um autor pode escrever sob uma subchave de uma anotação estruturada. O host o lê exatamente como lê o mesmo valor escrito no componente na Release, mantendo a ordem das chaves do objeto, de modo que um objeto pode alimentar uma associação que encaminha várias subchaves de uma vez, enquanto uma string alimenta uma associação que encaminha uma. Null, uma lista, um número, um booleano e um objeto sem subchaves são recusados, nomeando a injeção: uma injeção adiciona uma anotação e nunca remove uma nem renuncia a ela.

Não são permitidas propriedades adicionais.

AnnotationSource

Um arquivo de definição entregue ao plugin: o seu caminho de nome base e o conteúdo do arquivo. Ambos são carregados literalmente; o host não analisa o conteúdo.

PropriedadeTipoObrigatóriaDescrição
pathstringsimO nome base do arquivo de origem. O host fornece apenas o nome base, nunca um caminho absoluto do host, de modo que o formato de transmissão é portável e determinístico.
contentstringsimO conteúdo do arquivo de origem, carregado literalmente como uma string opaca.

Não são permitidas propriedades adicionais.