Skema Aggrega Wasm Annotation-Transform Socket
Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.
Id skema: https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json
Bentuk wire yang dikonsumsi (AnnotationTransformInput) dan dihasilkan (AnnotationTransformOutput) oleh plugin tata kelola yang dipasang pada peran annotation-transform. Peran ini berjalan setelah resolve dan sebelum ekspansi anotasi: plugin membaca target injeksi yang telah di-resolve dan kunci binding yang terdaftar pada Manifest, lalu mengembalikan daftar injeksi anotasi yang diterapkan host pada target tersebut sebelum ekspansi mengubah anotasi yang terikat menjadi lampiran Feature. Tipe payload Go, Rust, dan TypeScript dihasilkan dari skema ini ke dalam paket plugin-ABI, sehingga ketiga bahasa membaca dan menulis satu wire yang sama; guest mengimpornya dari paket tersebut, atau melalui kit plugin-nya jika kit tersebut mengekspor ulang tipe-tipe itu.
Salah satu dari bentuk berikut
AnnotationTransformInputAnnotationTransformOutput
Definisi
AnnotationTransformInput
Payload yang diserahkan host kepada plugin annotation-transform pada setiap pemanggilan: target injeksi yang telah di-resolve beserta anotasinya saat ini, kunci annotation-binding yang terdaftar pada Manifest, serta sumber yang disematkan dan pengaturan milik lampiran itu sendiri.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
targets | AnnotationTarget[] | ya | Target injeksi — komponen yang telah di-resolve yang dapat diinjeksi anotasi oleh plugin, masing-masing dengan set anotasinya saat ini sehingga plugin dapat memutuskan apa yang ditambahkan tanpa menimpa kunci yang sudah ada. Diurutkan secara deterministik oleh host. |
binding_keys | string[] | ya | Kunci anotasi yang binding-nya didaftarkan oleh Manifest, sesuai urutan penulis. Injeksi yang kuncinya terdaftar akan diekspansi menjadi lampiran Feature; plugin membaca daftar ini agar hanya menginjeksi kunci yang akan terikat. Host tidak mengharuskan injeksi menyebut kunci yang terdaftar — anotasi hasil injeksi yang tidak terdaftar berperilaku persis sama dengan anotasi tak terikat yang ditulis penulis. |
sources | AnnotationSource[] | tidak | Berkas definisi yang dibaca host dan diserahkan kepada plugin apa adanya, sebagai daftar berurutan yang diurutkan menurut path. Host membaca byte tersebut sebagai konten buram dan tidak mem-parse-nya. Tidak ada jika lampiran tidak mendeklarasikan sumber. |
settings | object | tidak | Objek pengaturan bebas yang diserahkan host kepada plugin apa adanya. Host tidak mem-parse atau menindaklanjuti isinya. Tidak ada jika lampiran tidak mendeklarasikan pengaturan. |
Properti tambahan tidak diizinkan.
AnnotationTransformOutput
Bentuk respons yang dihasilkan plugin annotation-transform: daftar injeksi anotasi yang diterapkan host pada target yang disebutkan. Host hanya menerapkan penambahan anotasi pada koordinat target yang sudah ada, masing-masing membawa nilai yang dapat ditulis penulis pada anotasi tersebut — string, atau objek berisi subkunci; injeksi yang menyebut koordinat yang tidak ada, atau yang membawa nilai dengan bentuk lain apa pun, akan menghentikan build secara eksplisit.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
injections | AnnotationInjection[] | ya | Injeksi anotasi yang diterapkan, secara berurutan. Masing-masing menyebut koordinat target yang sudah ada serta kunci anotasi dan nilai yang ditambahkan di sana. |
error | string | tidak | Pesan kegagalan yang ditetapkan ketika guest berjalan tetapi tidak dapat menyelesaikan operasinya; tidak ada jika berhasil. Host menampilkan error yang ada sebagai pemanggilan plugin yang gagal. |
Properti tambahan tidak diizinkan.
AnnotationTarget
Satu target injeksi yang telah di-resolve yang dapat diinjeksi anotasi oleh plugin: path batas dan nama komponennya, serta set anotasi yang sudah dibawa komponen tersebut.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
boundary_path | string | ya | Path batas yang dipisahkan garis miring tempat komponen berada di dalam Release. |
component_name | string | ya | Nama komponen di dalam batasnya. |
annotations | map dari string atau object atau null | ya | Anotasi yang ditulis Release pada komponen itu sendiri, dengan kunci berupa kunci anotasi dalam urutan penulisannya. Setiap nilai adalah apa yang ditulis penulis: string, objek berisi subkunci dalam urutan penulisannya sendiri, atau null jika komponen memilih keluar dari anotasi yang seharusnya diwarisinya. Setiap kunci ada apa pun nilainya, sehingga plugin dapat membedakan anotasi yang sudah dimiliki komponen dari yang belum dan hanya menambahkan yang belum ada. |
Properti tambahan tidak diizinkan.
AnnotationInjection
Satu anotasi yang diinjeksi ke sebuah target: koordinat target ditambah kunci anotasi dan nilainya.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
boundary_path | string | ya | Path batas yang dipisahkan garis miring dari komponen target. Harus menyebut target yang disediakan host; koordinat yang tidak dikenal menghentikan build. |
component_name | string | ya | Nama komponen target. Harus menyebut target yang disediakan host; koordinat yang tidak dikenal menghentikan build. |
annotation_key | string | ya | Kunci anotasi yang ditambahkan pada komponen target. |
annotation_value | string atau object | ya | Nilai anotasi, dibawa sebagai JSON-nya: string, atau objek yang kuncinya adalah subkunci dan entrinya adalah apa yang dapat ditulis penulis di bawah subkunci dari anotasi terstruktur. Host membacanya persis seperti membaca nilai yang sama yang ditulis pada komponen di Release, dengan mempertahankan urutan kunci objek, sehingga objek dapat mengisi binding yang merutekan beberapa subkunci sekaligus, sedangkan string mengisi binding yang merutekan satu subkunci. Null, list, angka, boolean, dan objek tanpa subkunci ditolak dengan menyebut injeksinya: injeksi menambahkan anotasi dan tidak pernah menghapus atau memilih keluar dari anotasi. |
Properti tambahan tidak diizinkan.
AnnotationSource
Satu berkas definisi yang diserahkan kepada plugin: path nama dasarnya dan isi berkas. Keduanya dibawa apa adanya; host tidak mem-parse isinya.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
path | string | ya | Nama dasar berkas sumber. Host hanya menyediakan nama dasar, tidak pernah path host absolut, sehingga wire bersifat portabel dan deterministik. |
content | string | ya | Isi berkas sumber, dibawa apa adanya sebagai string buram. |
Properti tambahan tidak diizinkan.