Schéma du socket Wasm annotation-transform d’Aggrega
Référence générée. Ne pas modifier à la main — régénérer à partir du JSON Schema publié.
Identifiant du schéma : https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json
Les formes de transmission qu’un plugin de gouvernance rattaché dans le rôle annotation-transform consomme (AnnotationTransformInput) et émet (AnnotationTransformOutput). Le rôle s’exécute après la résolution et avant l’expansion des annotations : le plugin lit les cibles d’injection résolues et les clés de liaison enregistrées du Manifest, et renvoie une liste d’injections d’annotations que l’hôte applique à ces cibles avant que l’expansion ne transforme les annotations liées en rattachements de Feature. Les types de payload Go, Rust et TypeScript sont générés à partir de ce schéma dans les paquets de l’ABI des plugins, de sorte que les trois langages lisent et écrivent le même format de transmission ; un invité les importe depuis ces paquets, ou via son kit de plugin lorsque le kit les réexporte.
L’une des formes suivantes
AnnotationTransformInputAnnotationTransformOutput
Définitions
AnnotationTransformInput
Le payload que l’hôte transmet au plugin annotation-transform à chaque invocation : les cibles d’injection résolues avec leurs annotations actuelles, les clés de liaison d’annotations enregistrées du Manifest, et les propres sources épinglées et réglages du rattachement.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
targets | AnnotationTarget[] | oui | Les cibles d’injection — les composants résolus sur lesquels le plugin peut injecter des annotations, chacun avec son ensemble d’annotations actuel, de sorte que le plugin peut décider quoi ajouter sans écraser une clé existante. Ordonnées de façon déterministe par l’hôte. |
binding_keys | string[] | oui | Les clés d’annotation pour lesquelles le Manifest enregistre une liaison, dans l’ordre de l’auteur. Une injection dont la clé est enregistrée s’étend en un rattachement de Feature ; le plugin lit cette liste afin de n’injecter que des clés qui seront liées. L’hôte n’exige pas qu’une injection nomme une clé enregistrée — une annotation injectée non enregistrée se comporte exactement comme une annotation non liée rédigée par un auteur. |
sources | AnnotationSource[] | non | Fichiers de définition que l’hôte lit et transmet tels quels au plugin, sous forme de liste ordonnée triée par chemin. L’hôte lit les octets comme un contenu opaque et ne les analyse pas. Absent lorsque le rattachement ne déclare aucune source. |
settings | object | non | Un objet de réglages libre que l’hôte transmet tel quel au plugin. L’hôte n’analyse pas son contenu et n’agit pas en fonction de celui-ci. Absent lorsque le rattachement ne déclare aucun réglage. |
Les propriétés supplémentaires ne sont pas autorisées.
AnnotationTransformOutput
La forme de réponse qu’émet le plugin annotation-transform : une liste d’injections d’annotations que l’hôte applique aux cibles nommées. L’hôte n’applique que des ajouts d’annotations à des coordonnées de cible existantes, chacun portant une valeur qu’un auteur pourrait écrire sur cette annotation — une chaîne, ou un objet de sous-clés ; une injection qui nomme une coordonnée inexistante, ou qui porte une valeur de toute autre forme, arrête le build de manière explicite.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
injections | AnnotationInjection[] | oui | Injections d’annotations à appliquer, dans l’ordre. Chacune nomme une coordonnée de cible existante ainsi que la clé et la valeur d’annotation à y ajouter. |
error | string | non | Un message d’échec défini lorsque l’invité s’est exécuté mais n’a pas pu terminer l’opération ; absent en cas de succès. L’hôte présente une erreur présente comme une invocation de plugin échouée. |
Les propriétés supplémentaires ne sont pas autorisées.
AnnotationTarget
Une cible d’injection résolue sur laquelle le plugin peut injecter des annotations : son chemin de frontière et son nom de composant, ainsi que l’ensemble d’annotations que le composant porte déjà.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
boundary_path | string | oui | Le chemin de frontière séparé par des barres obliques sous lequel se trouve le composant dans la Release. |
component_name | string | oui | Le nom du composant au sein de sa frontière. |
annotations | map de string ou object ou null | oui | Les annotations que la Release écrit sur le composant lui-même, indexées par clé d’annotation dans l’ordre où elles sont écrites. Chaque valeur est ce que l’auteur a écrit : une chaîne, un objet de sous-clés dans son propre ordre d’écriture, ou null là où le composant renonce à une annotation dont il hériterait sinon. Chaque clé est présente quelle que soit sa valeur, de sorte qu’un plugin peut distinguer une annotation que le composant porte déjà d’une annotation qu’il ne porte pas et n’ajouter que ce qui manque. |
Les propriétés supplémentaires ne sont pas autorisées.
AnnotationInjection
Une annotation à injecter sur une cible : la coordonnée de la cible plus la clé d’annotation et sa valeur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
boundary_path | string | oui | Le chemin de frontière séparé par des barres obliques du composant cible. Doit nommer une cible que l’hôte a fournie ; une coordonnée inconnue arrête le build. |
component_name | string | oui | Le nom du composant cible. Doit nommer une cible que l’hôte a fournie ; une coordonnée inconnue arrête le build. |
annotation_key | string | oui | La clé d’annotation à ajouter sur le composant cible. |
annotation_value | string ou object | oui | La valeur de l’annotation, portée sous forme de son JSON : une chaîne, ou un objet dont les clés sont des sous-clés et dont les entrées sont ce qu’un auteur peut écrire sous une sous-clé d’une annotation structurée. L’hôte la lit exactement comme il lit la même valeur écrite sur le composant dans la Release, en conservant l’ordre des clés de l’objet, de sorte qu’un objet peut alimenter une liaison qui achemine plusieurs sous-clés à la fois tandis qu’une chaîne alimente une liaison qui en achemine une. Null, une liste, un nombre, un booléen et un objet sans sous-clés sont refusés, en nommant l’injection : une injection ajoute une annotation et n’en supprime jamais une ni n’y renonce. |
Les propriétés supplémentaires ne sont pas autorisées.
AnnotationSource
Un fichier de définition transmis au plugin : son chemin de nom de base et le contenu du fichier. Les deux sont portés tels quels ; l’hôte n’analyse pas le contenu.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
path | string | oui | Le nom de base du fichier source. L’hôte ne fournit que le nom de base, jamais un chemin absolu de l’hôte, de sorte que le format de transmission est portable et déterministe. |
content | string | oui | Le contenu du fichier source, porté tel quel sous forme de chaîne opaque. |
Les propriétés supplémentaires ne sont pas autorisées.