Esquema do socket Wasm annotation-transform do Aggrega
Referência gerada. Não editar à mão — gerar 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 governação anexado 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 registadas do Manifest, e devolve uma lista de injeções de anotações que o host aplica a esses destinos antes de a expansão transformar as anotações associadas em anexos de Feature. Os tipos de payload de Go, Rust e TypeScript são gerados a partir deste esquema nos pacotes da ABI de plugins, pelo que as três linguagens leem e escrevem o mesmo formato de transmissão; um guest importa-os desses pacotes, ou através do seu kit de plugins quando o kit os reexporta.
Uma das seguintes formas
AnnotationTransformInputAnnotationTransformOutput
Definições
AnnotationTransformInput
O payload que o host entrega ao plugin annotation-transform em cada invocação: os destinos de injeção resolvidos com as suas anotações atuais, as chaves de associação de anotações registadas do Manifest, e as próprias origens fixadas e definições do anexo.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
targets | AnnotationTarget[] | sim | Os 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 acrescentar sem sobrescrever uma chave existente. Ordenados de forma determinística pelo host. |
binding_keys | string[] | sim | As chaves de anotação para as quais o Manifest regista uma associação, pela ordem do autor. Uma injeção cuja chave está registada expande-se num anexo 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 registada — uma anotação injetada não registada comporta-se exatamente como uma anotação não associada escrita por um autor. |
sources | AnnotationSource[] | não | Ficheiros 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 o anexo não declara origens. |
settings | objeto | não | Um objeto de definições de forma livre que o host entrega literalmente ao plugin. O host não analisa o seu conteúdo nem age com base nele. Ausente quando o anexo não declara definiçõ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 acréscimos de anotações a coordenadas de destino existentes, cada um com um valor que um autor poderia escrever nessa anotação — uma cadeia, ou um objeto de subchaves; uma injeção que nomeia uma coordenada inexistente, ou que transporta um valor de qualquer outra forma, interrompe a compilação de forma explícita.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
injections | AnnotationInjection[] | sim | Injeções de anotações a aplicar, por ordem. Cada uma nomeia uma coordenada de destino existente e a chave e o valor de anotação a acrescentar aí. |
error | string | não | Uma 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 falhada. |
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á transporta.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
boundary_path | string | sim | O caminho de fronteira separado por barras sob o qual o componente se encontra na Release. |
component_name | string | sim | O nome do componente dentro da sua fronteira. |
annotations | mapa de string ou object ou null | sim | As anotações que a Release escreve no próprio componente, indexadas por chave de anotação pela ordem em que estão escritas. Cada valor é aquilo que o autor escreveu: uma cadeia, um objeto de subchaves pela sua própria ordem de escrita, ou null onde o componente prescinde de uma anotação que de outro modo herdaria. Todas as chaves estão presentes qualquer que seja o seu valor, pelo que um plugin consegue distinguir uma anotação que o componente já transporta de uma que não transporta e acrescentar apenas o que falta. |
Não são permitidas propriedades adicionais.
AnnotationInjection
Uma anotação a injetar num destino: a coordenada do destino mais a chave da anotação e o seu valor.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
boundary_path | string | sim | O caminho de fronteira separado por barras do componente de destino. Tem de nomear um destino que o host forneceu; uma coordenada desconhecida interrompe a compilação. |
component_name | string | sim | O nome do componente de destino. Tem de nomear um destino que o host forneceu; uma coordenada desconhecida interrompe a compilação. |
annotation_key | string | sim | A chave de anotação a acrescentar no componente de destino. |
annotation_value | string ou object | sim | O valor da anotação, transportado como o seu JSON: uma cadeia, ou um objeto cujas chaves são subchaves e cujas entradas são aquilo que um autor pode escrever sob uma subchave de uma anotação estruturada. O host lê-o exatamente como lê o mesmo valor escrito no componente na Release, mantendo a ordem das chaves do objeto, pelo que um objeto pode alimentar uma associação que encaminha várias subchaves de uma vez, enquanto uma cadeia 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 acrescenta uma anotação e nunca remove uma nem prescinde dela. |
Não são permitidas propriedades adicionais.
AnnotationSource
Um ficheiro de definição entregue ao plugin: o seu caminho de nome base e o conteúdo do ficheiro. Ambos são transportados literalmente; o host não analisa o conteúdo.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
path | string | sim | O nome base do ficheiro de origem. O host fornece apenas o nome base, nunca um caminho absoluto do host, pelo que o formato de transmissão é portável e determinístico. |
content | string | sim | O conteúdo do ficheiro de origem, transportado literalmente como uma cadeia opaca. |
Não são permitidas propriedades adicionais.