Schema del socket Wasm annotation-transform di Aggrega
Riferimento generato. Non modificarlo a mano — rigeneralo a partire dal JSON Schema pubblicato.
Id dello schema: https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json
Le forme di trasmissione che un plugin di governance associato con il ruolo annotation-transform consuma (AnnotationTransformInput) ed emette (AnnotationTransformOutput). Il ruolo viene eseguito dopo la risoluzione e prima dell’espansione delle annotazioni: il plugin legge le destinazioni di iniezione risolte e le chiavi di legame registrate del Manifest, e restituisce un elenco di iniezioni di annotazioni che l’host applica a quelle destinazioni prima che l’espansione trasformi le annotazioni legate in associazioni di Feature. I tipi di payload Go, Rust e TypeScript sono generati da questo schema nei pacchetti dell’ABI dei plugin, così i tre linguaggi leggono e scrivono lo stesso formato di trasmissione; un guest li importa da quei pacchetti, oppure tramite il suo kit per plugin dove il kit li riesporta.
Una delle forme seguenti
AnnotationTransformInputAnnotationTransformOutput
Definizioni
AnnotationTransformInput
Il payload che l’host passa al plugin annotation-transform a ogni invocazione: le destinazioni di iniezione risolte con le loro annotazioni correnti, le chiavi di legame delle annotazioni registrate del Manifest, e le sorgenti fissate e le impostazioni proprie dell’associazione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
targets | AnnotationTarget[] | sì | Le destinazioni di iniezione — i componenti risolti su cui il plugin può iniettare annotazioni, ciascuno con il proprio insieme di annotazioni corrente, così il plugin può decidere che cosa aggiungere senza sovrascrivere una chiave esistente. Ordinate in modo deterministico dall’host. |
binding_keys | string[] | sì | Le chiavi di annotazione per cui il Manifest registra un legame, nell’ordine dell’autore. Un’iniezione la cui chiave è registrata si espande in un’associazione di Feature; il plugin legge questo elenco per iniettare solo chiavi che verranno legate. L’host non richiede che un’iniezione nomini una chiave registrata — un’annotazione iniettata non registrata si comporta esattamente come un’annotazione non legata scritta dall’autore. |
sources | AnnotationSource[] | no | File di definizione che l’host legge e passa al plugin alla lettera, come elenco ordinato per percorso. L’host legge i byte come contenuto opaco e non li analizza. Assente quando l’associazione non dichiara alcuna sorgente. |
settings | object | no | Un oggetto di impostazioni in forma libera che l’host passa al plugin alla lettera. L’host non ne analizza il contenuto né agisce su di esso. Assente quando l’associazione non dichiara alcuna impostazione. |
Non sono consentite proprietà aggiuntive.
AnnotationTransformOutput
La forma di risposta che il plugin annotation-transform emette: un elenco di iniezioni di annotazioni che l’host applica alle destinazioni nominate. L’host applica solo aggiunte di annotazioni a coordinate di destinazione esistenti, ciascuna con un valore che un autore potrebbe scrivere su quell’annotazione — una stringa, oppure un oggetto di sottochiavi; un’iniezione che nomina una coordinata inesistente, o che porta un valore di qualsiasi altra forma, arresta la build in modo esplicito.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
injections | AnnotationInjection[] | sì | Iniezioni di annotazioni da applicare, in ordine. Ciascuna nomina una coordinata di destinazione esistente e la chiave e il valore dell’annotazione da aggiungere lì. |
error | string | no | Un messaggio di errore impostato quando il guest è stato eseguito ma non ha potuto completare l’operazione; assente in caso di successo. L’host presenta un errore presente come un’invocazione del plugin non riuscita. |
Non sono consentite proprietà aggiuntive.
AnnotationTarget
Una destinazione di iniezione risolta su cui il plugin può iniettare annotazioni: il suo percorso del confine e il nome del componente, e l’insieme di annotazioni che il componente porta già.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
boundary_path | string | sì | Il percorso del confine, separato da barre, sotto cui si trova il componente nella Release. |
component_name | string | sì | Il nome del componente all’interno del suo confine. |
annotations | mappa di string o object o null | sì | Le annotazioni che la Release scrive sul componente stesso, indicizzate per chiave di annotazione nell’ordine in cui sono scritte. Ogni valore è ciò che l’autore ha scritto: una stringa, un oggetto di sottochiavi nel proprio ordine di scrittura, oppure null dove il componente rinuncia a un’annotazione che altrimenti erediterebbe. Ogni chiave è presente qualunque sia il suo valore, così un plugin può distinguere un’annotazione che il componente porta già da una che non porta e aggiungere solo ciò che manca. |
Non sono consentite proprietà aggiuntive.
AnnotationInjection
Un’annotazione da iniettare su una destinazione: la coordinata della destinazione più la chiave dell’annotazione e il suo valore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
boundary_path | string | sì | Il percorso del confine, separato da barre, del componente di destinazione. Deve nominare una destinazione fornita dall’host; una coordinata sconosciuta arresta la build. |
component_name | string | sì | Il nome del componente di destinazione. Deve nominare una destinazione fornita dall’host; una coordinata sconosciuta arresta la build. |
annotation_key | string | sì | La chiave dell’annotazione da aggiungere sul componente di destinazione. |
annotation_value | string o object | sì | Il valore dell’annotazione, portato come il suo JSON: una stringa, oppure un oggetto le cui chiavi sono sottochiavi e le cui voci sono ciò che un autore può scrivere sotto una sottochiave di un’annotazione strutturata. L’host lo legge esattamente come legge lo stesso valore scritto sul componente nella Release, mantenendo l’ordine delle chiavi dell’oggetto, così un oggetto può alimentare un legame che instrada più sottochiavi insieme mentre una stringa alimenta un legame che ne instrada una. Null, una lista, un numero, un booleano e un oggetto senza sottochiavi vengono rifiutati, nominando l’iniezione: un’iniezione aggiunge un’annotazione e non ne rimuove mai una né vi rinuncia. |
Non sono consentite proprietà aggiuntive.
AnnotationSource
Un file di definizione passato al plugin: il suo percorso con il nome base e il contenuto del file. Entrambi sono portati alla lettera; l’host non analizza il contenuto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
path | string | sì | Il nome base del file sorgente. L’host fornisce solo il nome base, mai un percorso assoluto dell’host, così il formato di trasmissione è portabile e deterministico. |
content | string | sì | Il contenuto del file sorgente, portato alla lettera come stringa opaca. |
Non sono consentite proprietà aggiuntive.