Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Схема сокета Aggrega Wasm Annotation-Transform

Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.

Идентификатор схемы: https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json

Формы передаваемых данных, которые плагин управления, подключённый в роли annotation-transform, принимает (AnnotationTransformInput) и выдаёт (AnnotationTransformOutput). Роль выполняется после разрешения и до раскрытия аннотаций: плагин читает разрешённые цели внедрения и зарегистрированные ключи привязки сущности Manifest и возвращает список внедрений аннотаций, которые хост применяет к этим целям до того, как раскрытие превратит привязанные аннотации в подключения сущностей Feature. Типы полезной нагрузки для Go, Rust и TypeScript генерируются из этой схемы в пакеты plugin-ABI, поэтому все три языка читают и записывают одни и те же передаваемые данные; гостевой модуль импортирует их из этих пакетов или через свой набор для разработки плагинов, если тот их реэкспортирует.

Одна из следующих форм

  • AnnotationTransformInput
  • AnnotationTransformOutput

Определения

AnnotationTransformInput

Полезная нагрузка, которую хост передаёт плагину annotation-transform при каждом вызове: разрешённые цели внедрения с их текущими аннотациями, зарегистрированные ключи привязки аннотаций сущности Manifest, а также закреплённые источники и настройки самого подключения.

СвойствоТипОбязательноОписание
targetsAnnotationTarget[]даЦели внедрения — разрешённые компоненты, в которые плагин может внедрять аннотации, каждый со своим текущим набором аннотаций, чтобы плагин мог решить, что добавить, не затирая существующий ключ. Хост упорядочивает их детерминированно.
binding_keysstring[]даКлючи аннотаций, для которых сущность Manifest регистрирует привязку, в авторском порядке. Внедрение с зарегистрированным ключом раскрывается в подключение сущности Feature; плагин читает этот список, чтобы внедрять только ключи, которые будут привязаны. Хост не требует, чтобы внедрение указывало зарегистрированный ключ: внедрённая незарегистрированная аннотация ведёт себя точно так же, как написанная автором непривязанная аннотация.
sourcesAnnotationSource[]нетФайлы определений, которые хост читает и передаёт плагину без изменений в виде упорядоченного списка, отсортированного по пути. Хост читает байты как непрозрачное содержимое и не разбирает их. Отсутствует, если подключение не объявляет источников.
settingsobjectнетОбъект настроек произвольной формы, который хост передаёт плагину без изменений. Хост не разбирает его содержимое и не действует на его основе. Отсутствует, если подключение не объявляет настроек.

Дополнительные свойства не допускаются.

AnnotationTransformOutput

Форма ответа, которую выдаёт плагин annotation-transform: список внедрений аннотаций, которые хост применяет к указанным целям. Хост применяет только добавление аннотаций к существующим координатам целей, причём каждая несёт значение, которое автор мог бы записать в этой аннотации, — строку или объект подключей; внедрение, указывающее несуществующую координату или несущее значение любой другой формы, явно останавливает сборку.

СвойствоТипОбязательноОписание
injectionsAnnotationInjection[]даВнедрения аннотаций, которые нужно применить, по порядку. Каждое указывает существующую координату цели, а также ключ аннотации и значение, которые нужно туда добавить.
errorstringнетСообщение об ошибке, задаваемое, когда гостевой модуль выполнился, но не смог завершить операцию; отсутствует при успехе. Хост представляет присутствующую ошибку как неудачный вызов плагина.

Дополнительные свойства не допускаются.

AnnotationTarget

Одна разрешённая цель внедрения, в которую плагин может внедрять аннотации: её путь границы и имя компонента, а также набор аннотаций, который у компонента уже есть.

СвойствоТипОбязательноОписание
boundary_pathstringдаРазделённый косыми чертами путь границы, под которой компонент находится в сущности Release.
component_namestringдаИмя компонента в пределах его границы.
annotationsmap из string, object или nullдаАннотации, которые Release записывает на самом компоненте, с ключами по ключу аннотации в порядке записи. Каждое значение — то, что написал автор: строка, объект подключей в собственном порядке записи или null там, где компонент отказывается от аннотации, которую иначе унаследовал бы. Каждый ключ присутствует независимо от значения, поэтому плагин может отличить аннотацию, которую компонент уже несёт, от той, которой у него нет, и добавить только отсутствующее.

Дополнительные свойства не допускаются.

AnnotationInjection

Одна аннотация для внедрения в цель: координата цели, а также ключ аннотации и её значение.

СвойствоТипОбязательноОписание
boundary_pathstringдаРазделённый косыми чертами путь границы целевого компонента. Должен указывать цель, предоставленную хостом; неизвестная координата останавливает сборку.
component_namestringдаИмя целевого компонента. Должно указывать цель, предоставленную хостом; неизвестная координата останавливает сборку.
annotation_keystringдаКлюч аннотации, добавляемой в целевой компонент.
annotation_valuestring или objectдаЗначение аннотации, передаваемое в виде JSON: строка или объект, ключи которого — подключи, а элементы — то, что автор может записать под подключом структурированной аннотации. Хост читает его точно так же, как читает то же значение, записанное на компоненте в Release, сохраняя порядок ключей объекта, поэтому объект может питать привязку, маршрутизирующую сразу несколько подключей, а строка — привязку, маршрутизирующую один. Null, список, число, логическое значение и объект без подключей отклоняются с указанием внедрения: внедрение добавляет аннотацию и никогда не удаляет её и не отказывается от неё.

Дополнительные свойства не допускаются.

AnnotationSource

Один файл определений, передаваемый плагину: путь в виде базового имени и содержимое файла. Оба передаются без изменений; хост не разбирает содержимое.

СвойствоТипОбязательноОписание
pathstringдаБазовое имя исходного файла. Хост передаёт только базовое имя и никогда — абсолютный путь на хосте, поэтому передаваемые данные переносимы и детерминированы.
contentstringдаСодержимое исходного файла, передаваемое без изменений как непрозрачная строка.

Дополнительные свойства не допускаются.