Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Esquema del socket Wasm annotation-transform de Aggrega

Referencia generada. No la edites a mano — regenérala a partir del JSON Schema publicado.

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

Las formas de transmisión que un plugin de gobernanza vinculado en el rol annotation-transform consume (AnnotationTransformInput) y emite (AnnotationTransformOutput). El rol se ejecuta después de la resolución y antes de la expansión de anotaciones: el plugin lee los destinos de inyección resueltos y las claves de enlace registradas del Manifest, y devuelve una lista de inyecciones de anotaciones que el host aplica a esos destinos antes de que la expansión convierta las anotaciones enlazadas en vinculaciones de Feature. Los tipos de payload de Go, Rust y TypeScript se generan a partir de este esquema en los paquetes de la ABI de plugins, de modo que los tres lenguajes leen y escriben el mismo formato de transmisión; un guest los importa desde esos paquetes, o a través de su kit de plugins cuando el kit los reexporta.

Una de las siguientes formas

  • AnnotationTransformInput
  • AnnotationTransformOutput

Definiciones

AnnotationTransformInput

El payload que el host entrega al plugin annotation-transform en cada invocación: los destinos de inyección resueltos con sus anotaciones actuales, las claves de enlace de anotaciones registradas del Manifest, y las propias fuentes fijadas y ajustes de la vinculación.

PropiedadTipoObligatoriaDescripción
targetsAnnotationTarget[]síLos destinos de inyección — los componentes resueltos sobre los que el plugin puede inyectar anotaciones, cada uno con su conjunto de anotaciones actual para que el plugin pueda decidir qué añadir sin sobrescribir una clave existente. Ordenados de forma determinista por el host.
binding_keysstring[]síLas claves de anotación para las que el Manifest registra un enlace, en el orden del autor. Una inyección cuya clave está registrada se expande en una vinculación de Feature; el plugin lee esta lista para inyectar solo claves que se enlazarán. El host no exige que una inyección nombre una clave registrada — una anotación inyectada no registrada se comporta exactamente como una anotación no enlazada escrita por un autor.
sourcesAnnotationSource[]noArchivos de definición que el host lee y entrega literalmente al plugin, como una lista ordenada por ruta. El host lee los bytes como contenido opaco y no los analiza. Ausente cuando la vinculación no declara fuentes.
settingsobjectnoUn objeto de ajustes de forma libre que el host entrega literalmente al plugin. El host no analiza su contenido ni actúa según él. Ausente cuando la vinculación no declara ajustes.

No se permiten propiedades adicionales.

AnnotationTransformOutput

La forma de respuesta que emite el plugin annotation-transform: una lista de inyecciones de anotaciones que el host aplica a los destinos nombrados. El host aplica solo adiciones de anotaciones a coordenadas de destino existentes, cada una con un valor que un autor podría escribir en esa anotación — una cadena, o un objeto de subclaves; una inyección que nombra una coordenada inexistente, o que lleva un valor de cualquier otra forma, detiene la compilación de forma explícita.

PropiedadTipoObligatoriaDescripción
injectionsAnnotationInjection[]síInyecciones de anotaciones que se aplican, en orden. Cada una nombra una coordenada de destino existente y la clave y el valor de anotación que se añaden allí.
errorstringnoUn mensaje de error que se establece cuando el guest se ejecutó pero no pudo completar la operación; ausente en caso de éxito. El host presenta un error presente como una invocación de plugin fallida.

No se permiten propiedades adicionales.

AnnotationTarget

Un destino de inyección resuelto sobre el que el plugin puede inyectar anotaciones: su ruta de límite y su nombre de componente, y el conjunto de anotaciones que el componente ya lleva.

PropiedadTipoObligatoriaDescripción
boundary_pathstringsíLa ruta de límite separada por barras bajo la que se encuentra el componente en la Release.
component_namestringsíEl nombre del componente dentro de su límite.
annotationsmapa de string u object o nullsíLas anotaciones que la Release escribe en el propio componente, indexadas por clave de anotación en el orden en que están escritas. Cada valor es lo que escribió el autor: una cadena, un objeto de subclaves en su propio orden de escritura, o null donde el componente renuncia a una anotación que de otro modo heredaría. Cada clave está presente sea cual sea su valor, de modo que un plugin puede distinguir una anotación que el componente ya lleva de una que no lleva y añadir solo lo que falta.

No se permiten propiedades adicionales.

AnnotationInjection

Una anotación que se inyecta en un destino: la coordenada del destino más la clave de la anotación y su valor.

PropiedadTipoObligatoriaDescripción
boundary_pathstringsíLa ruta de límite separada por barras del componente de destino. Debe nombrar un destino que proporcionó el host; una coordenada desconocida detiene la compilación.
component_namestringsíEl nombre del componente de destino. Debe nombrar un destino que proporcionó el host; una coordenada desconocida detiene la compilación.
annotation_keystringsíLa clave de anotación que se añade en el componente de destino.
annotation_valuestring u objectsíEl valor de la anotación, llevado como su JSON: una cadena, o un objeto cuyas claves son subclaves y cuyas entradas son lo que un autor puede escribir bajo una subclave de una anotación estructurada. El host lo lee exactamente como lee el mismo valor escrito en el componente en la Release, conservando el orden de claves del objeto, de modo que un objeto puede alimentar un enlace que encamina varias subclaves a la vez mientras que una cadena alimenta un enlace que encamina una. Null, una lista, un número, un booleano y un objeto sin subclaves se rechazan, nombrando la inyección: una inyección añade una anotación y nunca elimina una ni renuncia a ella.

No se permiten propiedades adicionales.

AnnotationSource

Un archivo de definición entregado al plugin: su ruta de nombre base y el contenido del archivo. Ambos se llevan literalmente; el host no analiza el contenido.

PropiedadTipoObligatoriaDescripción
pathstringsíEl nombre base del archivo de origen. El host proporciona solo el nombre base, nunca una ruta absoluta del host, de modo que el formato de transmisión es portable y determinista.
contentstringsíEl contenido del archivo de origen, llevado literalmente como una cadena opaca.

No se permiten propiedades adicionales.