Aggrega Wasm 注解转换(Annotation-Transform)插槽 schema
自动生成的参考文档。请勿手动编辑——请从发布的 JSON Schema 重新生成。
Schema id:https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json
挂载在注解转换(annotation-transform)角色上的治理插件所消费(AnnotationTransformInput)和输出(AnnotationTransformOutput)的传输形态。该角色在解析之后、注解展开之前运行:插件读取已解析的注入目标和 Manifest 中已注册的绑定键,并返回一个注解注入列表;在展开将已绑定的注解转换为 Feature 挂载之前,宿主将这些注入应用到对应目标上。Go、Rust 和 TypeScript 的载荷类型由此 schema 生成到 plugin-ABI 包中,因此三种语言读写同一种传输数据;guest 从这些包中导入它们,或在插件工具包重新导出它们时通过插件工具包导入。
以下形态之一
AnnotationTransformInputAnnotationTransformOutput
定义
AnnotationTransformInput
宿主在每次调用时传给注解转换插件的载荷:已解析的注入目标及其当前注解、Manifest 中已注册的注解绑定键,以及该挂载自身固定的源文件和设置。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
targets | AnnotationTarget[] | 是 | 注入目标——插件可以向其注入注解的已解析组件,每个目标都附带其当前注解集,以便插件决定要添加的内容而不覆盖已有的键。由宿主按确定性顺序排列。 |
binding_keys | string[] | 是 | Manifest 为其注册了绑定的注解键,按作者编写顺序排列。键已注册的注入会展开为一个 Feature 挂载;插件读取此列表,从而只注入会被绑定的键。宿主不要求注入必须指定已注册的键——未注册的注入注解与作者编写的未绑定注解行为完全相同。 |
sources | AnnotationSource[] | 否 | 宿主读取并原样传给插件的定义文件,以按路径排序的有序列表形式提供。宿主将这些字节作为不透明内容读取,不对其进行解析。当挂载未声明任何源文件时不存在。 |
settings | object | 否 | 宿主原样传给插件的自由格式设置对象。宿主不解析其内容,也不据此执行任何操作。当挂载未声明任何设置时不存在。 |
不允许其他属性。
AnnotationTransformOutput
注解转换插件输出的响应形态:宿主应用到指定目标上的注解注入列表。宿主只应用向已有目标坐标添加注解的操作,每个注解携带作者可以在该注解上写入的值——字符串,或由子键组成的对象;指定不存在坐标的注入,或携带其他任何形态的值的注入,会以显式报错的方式中止构建。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
injections | AnnotationInjection[] | 是 | 要按顺序应用的注解注入。每一项指定一个已有的目标坐标,以及要在该处添加的注解键和值。 |
error | string | 否 | guest 已运行但无法完成操作时设置的失败消息;成功时不存在。宿主将存在的 error 呈现为一次失败的插件调用。 |
不允许其他属性。
AnnotationTarget
插件可以向其注入注解的一个已解析注入目标:其边界路径和组件名称,以及该组件已携带的注解集。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
boundary_path | string | 是 | 该组件在 Release 中所处的以斜杠分隔的边界路径。 |
component_name | string | 是 | 该组件在其边界内的名称。 |
annotations | string、object 或 null 的映射 | 是 | Release 在该组件本身上写入的注解,以注解键为键,按写入顺序排列。每个值都是作者所写的内容:字符串、按其自身书写顺序排列的子键对象,或者在组件选择退出本会继承的注解时为 null。无论值为何,每个键都会出现,因此插件可以区分组件已携带的注解与未携带的注解,并只添加缺失的部分。 |
不允许其他属性。
AnnotationInjection
要注入到某个目标上的一个注解:目标坐标,以及注解键及其值。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
boundary_path | string | 是 | 目标组件的以斜杠分隔的边界路径。必须指定宿主提供的目标;未知坐标会中止构建。 |
component_name | string | 是 | 目标组件的名称。必须指定宿主提供的目标;未知坐标会中止构建。 |
annotation_key | string | 是 | 要在目标组件上添加的注解键。 |
annotation_value | string 或 object | 是 | 注解的值,以其 JSON 形式携带:字符串,或一个对象,其键为子键,其条目为作者可在结构化注解的子键下写入的内容。宿主读取它的方式与读取在 Release 中写在该组件上的相同值完全一致,并保留对象的键顺序,因此对象可以为一次路由多个子键的绑定提供输入,而字符串为只路由一个子键的绑定提供输入。null、列表、数字、布尔值以及没有子键的对象都会被拒绝,并指出该注入:注入只添加注解,从不移除注解,也从不选择退出注解。 |
不允许其他属性。
AnnotationSource
传给插件的一个定义文件:其基本名称路径和文件内容。两者均原样传递;宿主不解析内容。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
path | string | 是 | 源文件的基本名称。宿主只提供基本名称,从不提供宿主上的绝对路径,因此传输内容可移植且具有确定性。 |
content | string | 是 | 源文件的内容,作为不透明字符串原样传递。 |
不允许其他属性。