Schema của Aggrega Wasm Annotation-Transform Socket
Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.
Id của schema: https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json
Các dạng dữ liệu truyền mà một plugin quản trị gắn ở vai trò annotation-transform tiêu thụ (AnnotationTransformInput) và phát ra (AnnotationTransformOutput). Vai trò này chạy sau bước resolve và trước bước mở rộng annotation: plugin đọc các đích chèn đã được phân giải và các khóa binding đã đăng ký của Manifest, rồi trả về một danh sách các annotation cần chèn mà host áp dụng lên các đích đó trước khi bước mở rộng biến các annotation đã được bind thành các phần gắn Feature. Các kiểu payload Go, Rust và TypeScript được sinh từ schema này vào các gói plugin-ABI, nên ba ngôn ngữ đọc và ghi cùng một dạng dữ liệu truyền; một guest nhập chúng từ các gói đó, hoặc thông qua bộ kit plugin của nó nếu bộ kit tái xuất chúng.
Một trong các dạng sau
AnnotationTransformInputAnnotationTransformOutput
Định nghĩa
AnnotationTransformInput
Payload mà host trao cho plugin annotation-transform ở mỗi lần gọi: các đích chèn đã được phân giải cùng các annotation hiện có của chúng, các khóa annotation-binding đã đăng ký của Manifest, và các nguồn được ghim cùng các thiết lập riêng của phần gắn.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
targets | AnnotationTarget[] | có | Các đích chèn — các component đã được phân giải mà plugin có thể chèn annotation vào, mỗi component kèm tập annotation hiện tại để plugin có thể quyết định thêm gì mà không ghi đè một khóa đã có. Được host sắp xếp theo thứ tự tất định. |
binding_keys | string[] | có | Các khóa annotation mà Manifest đăng ký binding, theo thứ tự của tác giả. Một lần chèn có khóa đã đăng ký sẽ được mở rộng thành một phần gắn Feature; plugin đọc danh sách này để chỉ chèn các khóa sẽ được bind. Host không yêu cầu một lần chèn phải nêu một khóa đã đăng ký — một annotation được chèn mà chưa đăng ký hoạt động hệt như một annotation do tác giả viết mà không được bind. |
sources | AnnotationSource[] | không | Các tệp định nghĩa mà host đọc và trao nguyên văn cho plugin, dưới dạng một danh sách có thứ tự được sắp xếp theo đường dẫn. Host đọc các byte như nội dung mờ và không phân tích chúng. Vắng mặt khi phần gắn không khai báo nguồn nào. |
settings | object | không | Một đối tượng thiết lập dạng tự do mà host trao nguyên văn cho plugin. Host không phân tích hay xử lý nội dung của nó. Vắng mặt khi phần gắn không khai báo thiết lập nào. |
Không cho phép thuộc tính bổ sung.
AnnotationTransformOutput
Dạng phản hồi mà plugin annotation-transform phát ra: một danh sách các annotation cần chèn mà host áp dụng lên các đích được nêu. Host chỉ áp dụng việc thêm annotation vào các tọa độ đích đã tồn tại, mỗi lần thêm mang một giá trị mà tác giả có thể viết trên annotation đó — một chuỗi, hoặc một đối tượng gồm các khóa con; một lần chèn nêu một tọa độ không tồn tại, hoặc mang một giá trị có bất kỳ dạng nào khác, sẽ dừng bản build một cách rõ ràng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
injections | AnnotationInjection[] | có | Các annotation cần chèn, theo thứ tự. Mỗi mục nêu một tọa độ đích đã tồn tại cùng khóa annotation và giá trị cần thêm vào đó. |
error | string | không | Thông điệp lỗi được đặt khi guest đã chạy nhưng không thể hoàn tất thao tác; vắng mặt khi thành công. Host thể hiện một error có mặt dưới dạng một lần gọi plugin thất bại. |
Không cho phép thuộc tính bổ sung.
AnnotationTarget
Một đích chèn đã được phân giải mà plugin có thể chèn annotation vào: đường dẫn ranh giới và tên component của nó, cùng tập annotation mà component đã mang.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
boundary_path | string | có | Đường dẫn ranh giới phân tách bằng dấu gạch chéo mà component nằm dưới trong Release. |
component_name | string | có | Tên của component trong ranh giới của nó. |
annotations | map của string hoặc object hoặc null | có | Các annotation mà Release viết trên chính component, được khóa theo khóa annotation theo thứ tự chúng được viết. Mỗi giá trị là những gì tác giả đã viết: một chuỗi, một đối tượng gồm các khóa con theo thứ tự viết riêng của nó, hoặc null ở nơi component từ chối một annotation mà nếu không nó sẽ kế thừa. Mọi khóa đều có mặt bất kể giá trị là gì, nên một plugin có thể phân biệt annotation mà component đã mang với annotation nó chưa mang và chỉ thêm những gì còn thiếu. |
Không cho phép thuộc tính bổ sung.
AnnotationInjection
Một annotation cần chèn vào một đích: tọa độ đích cùng khóa annotation và giá trị của nó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
boundary_path | string | có | Đường dẫn ranh giới phân tách bằng dấu gạch chéo của component đích. Phải nêu một đích mà host đã cung cấp; một tọa độ không xác định sẽ dừng bản build. |
component_name | string | có | Tên của component đích. Phải nêu một đích mà host đã cung cấp; một tọa độ không xác định sẽ dừng bản build. |
annotation_key | string | có | Khóa annotation cần thêm vào component đích. |
annotation_value | string hoặc object | có | Giá trị của annotation, được mang dưới dạng JSON của nó: một chuỗi, hoặc một đối tượng có các khóa là khóa con và các mục là những gì tác giả có thể viết dưới một khóa con của một annotation có cấu trúc. Host đọc nó đúng như cách nó đọc cùng giá trị đó khi được viết trên component trong Release, giữ nguyên thứ tự khóa của đối tượng, nên một đối tượng có thể cung cấp cho một binding định tuyến nhiều khóa con cùng lúc, còn một chuỗi cung cấp cho một binding định tuyến một khóa con. Null, danh sách, số, boolean và đối tượng không có khóa con đều bị từ chối, kèm nêu tên lần chèn: một lần chèn thêm một annotation và không bao giờ xóa hay từ chối một annotation. |
Không cho phép thuộc tính bổ sung.
AnnotationSource
Một tệp định nghĩa được trao cho plugin: đường dẫn tên cơ sở và nội dung của tệp. Cả hai được truyền nguyên văn; host không phân tích nội dung.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
path | string | có | Tên cơ sở của tệp nguồn. Host chỉ cung cấp tên cơ sở, không bao giờ là một đường dẫn tuyệt đối trên host, để dữ liệu truyền có tính di động và tất định. |
content | string | có | Nội dung của tệp nguồn, được truyền nguyên văn dưới dạng một chuỗi mờ. |
Không cho phép thuộc tính bổ sung.