Схема сокета Annotation-Transform для Aggrega Wasm
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json
Формати передавання даних, які споживає (AnnotationTransformInput) і видає (AnnotationTransformOutput) плагін керування, приєднаний у ролі annotation-transform. Роль виконується після розв’язання і перед розгортанням анотацій: плагін читає розв’язані цілі ін’єкції та зареєстровані ключі прив’язки сутності Manifest і повертає список ін’єкцій анотацій, які хост застосовує до цих цілей, перш ніж розгортання перетворить прив’язані анотації на приєднання сутностей Feature. Типи корисного навантаження для Go, Rust і TypeScript генеруються з цієї схеми в пакети plugin-ABI, тож усі три мови читають і записують ті самі дані передавання; гостьовий модуль імпортує їх із цих пакетів або через свій набір для плагінів, якщо той їх реекспортує.
Одна з наведених нижче форм
AnnotationTransformInputAnnotationTransformOutput
Визначення
AnnotationTransformInput
Корисне навантаження, яке хост передає плагіну annotation-transform під час кожного виклику: розв’язані цілі ін’єкції з їхніми поточними анотаціями, зареєстровані ключі прив’язки анотацій сутності Manifest, а також власні закріплені джерела й налаштування приєднання.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
targets | AnnotationTarget[] | так | Цілі ін’єкції — розв’язані компоненти, на які плагін може додавати анотації, кожен зі своїм поточним набором анотацій, щоб плагін міг вирішити, що додати, не перезаписавши наявний ключ. Хост упорядковує їх детерміновано. |
binding_keys | string[] | так | Ключі анотацій, для яких Manifest реєструє прив’язку, у порядку автора. Ін’єкція, ключ якої зареєстровано, розгортається в приєднання Feature; плагін читає цей список, щоб додавати лише ключі, які буде прив’язано. Хост не вимагає, щоб ін’єкція називала зареєстрований ключ — незареєстрована додана анотація поводиться точно так само, як написана автором неприв’язана анотація. |
sources | AnnotationSource[] | ні | Файли визначень, які хост читає й передає плагіну без змін, як упорядкований список, відсортований за шляхом. Хост читає байти як непрозорий вміст і не розбирає їх. Відсутнє, якщо приєднання не оголошує джерел. |
settings | object | ні | Об’єкт налаштувань довільної форми, який хост передає плагіну без змін. Хост не розбирає його вміст і не діє на його основі. Відсутнє, якщо приєднання не оголошує налаштувань. |
Додаткові властивості не дозволені.
AnnotationTransformOutput
Формат відповіді, який видає плагін annotation-transform: список ін’єкцій анотацій, які хост застосовує до названих цілей. Хост застосовує лише додавання анотацій до наявних координат цілей, і кожне з них містить значення, яке автор міг би записати в цій анотації, — рядок або об’єкт підключів; ін’єкція, що називає неіснуючу координату або містить значення будь-якої іншої форми, явно зупиняє збірку.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
injections | AnnotationInjection[] | так | Ін’єкції анотацій, які слід застосувати, по порядку. Кожна називає наявну координату цілі, а також ключ анотації та значення, які туди слід додати. |
error | string | ні | Повідомлення про збій, що встановлюється, коли гостьовий модуль виконався, але не зміг завершити операцію; відсутнє в разі успіху. Хост подає наявну помилку як невдалий виклик плагіна. |
Додаткові властивості не дозволені.
AnnotationTarget
Одна розв’язана ціль ін’єкції, на яку плагін може додавати анотації: її шлях межі та ім’я компонента, а також набір анотацій, який компонент уже має.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
boundary_path | string | так | Шлях межі з роздільниками-скісними рисками, під яким компонент розташований у сутності Release. |
component_name | string | так | Ім’я компонента в межах його межі. |
annotations | map of string or object or null | так | Анотації, які Release записує на самому компоненті, з ключами за ключем анотації в порядку запису. Кожне значення — те, що записав автор: рядок, об’єкт підключів у власному порядку запису або null там, де компонент відмовляється від анотації, яку інакше успадкував би. Кожен ключ присутній незалежно від значення, тож плагін може відрізнити анотацію, яку компонент уже має, від тієї, якої він не має, і додати лише відсутнє. |
Додаткові властивості не дозволені.
AnnotationInjection
Одна анотація для додавання на ціль: координата цілі, а також ключ анотації та її значення.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
boundary_path | string | так | Шлях межі цільового компонента з роздільниками-скісними рисками. Має називати ціль, яку надав хост; невідома координата зупиняє збірку. |
component_name | string | так | Ім’я цільового компонента. Має називати ціль, яку надав хост; невідома координата зупиняє збірку. |
annotation_key | string | так | Ключ анотації, який слід додати на цільовий компонент. |
annotation_value | рядок або об’єкт | так | Значення анотації, що передається як його JSON: рядок або об’єкт, ключі якого є підключами, а елементи — тим, що автор може записати під підключем структурованої анотації. Хост читає його точно так само, як читає те саме значення, записане на компоненті в Release, зберігаючи порядок ключів об’єкта, тож об’єкт може живити прив’язку, що маршрутизує кілька підключів одночасно, а рядок — прив’язку, що маршрутизує один. Null, список, число, логічне значення та об’єкт без підключів відхиляються із зазначенням ін’єкції: ін’єкція додає анотацію і ніколи не видаляє її та не відмовляється від неї. |
Додаткові властивості не дозволені.
AnnotationSource
Один файл визначення, переданий плагіну: його шлях у вигляді базового імені та вміст файлу. Обидва передаються без змін; хост не розбирає вміст.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
path | string | так | Базове ім’я вихідного файлу. Хост надає лише базове ім’я, ніколи не абсолютний шлях на хості, тож передані дані переносні й детерміновані. |
content | string | так | Вміст вихідного файлу, переданий без змін як непрозорий рядок. |
Додаткові властивості не дозволені.