Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Schemat gniazda Aggrega Wasm Annotation-Transform

Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.

Identyfikator schematu: https://aggrega.ai/schemas/wasm-annotation-transform-v1beta1.schema.json

Kształty komunikatów, które plugin zarządczy podłączony w roli annotation-transform przyjmuje (AnnotationTransformInput) i emituje (AnnotationTransformOutput). Rola ta działa po rozwiązaniu i przed rozwinięciem adnotacji: plugin odczytuje rozwiązane cele wstrzykiwania oraz klucze powiązań zarejestrowane w encji Manifest i zwraca listę wstrzyknięć adnotacji, które host stosuje do tych celów, zanim rozwinięcie zamieni powiązane adnotacje w dołączenia encji Feature. Typy ładunków dla Go, Rust i TypeScript są generowane z tego schematu do pakietów plugin-ABI, więc trzy języki odczytują i zapisują jeden format komunikatów; gość importuje je z tych pakietów albo przez swój zestaw narzędzi dla pluginów, jeśli zestaw je reeksportuje.

Jeden z następujących kształtów

  • AnnotationTransformInput
  • AnnotationTransformOutput

Definicje

AnnotationTransformInput

Ładunek, który host przekazuje pluginowi annotation-transform przy każdym wywołaniu: rozwiązane cele wstrzykiwania wraz z ich bieżącymi adnotacjami, klucze powiązań adnotacji zarejestrowane w encji Manifest oraz przypięte źródła i ustawienia samego dołączenia.

WłaściwośćTypWymaganaOpis
targetsAnnotationTarget[]takCele wstrzykiwania — rozwiązane komponenty, do których plugin może wstrzykiwać adnotacje, każdy z bieżącym zestawem adnotacji, aby plugin mógł zdecydować, co dodać, bez nadpisywania istniejącego klucza. Host porządkuje je deterministycznie.
binding_keysstring[]takKlucze adnotacji, dla których Manifest rejestruje powiązanie, w kolejności autora. Wstrzyknięcie, którego klucz jest zarejestrowany, rozwija się w dołączenie encji Feature; plugin odczytuje tę listę, aby wstrzykiwać tylko klucze, które zostaną powiązane. Host nie wymaga, aby wstrzyknięcie wskazywało zarejestrowany klucz — wstrzyknięta niezarejestrowana adnotacja zachowuje się dokładnie tak jak napisana przez autora niepowiązana adnotacja.
sourcesAnnotationSource[]niePliki definicji, które host odczytuje i przekazuje pluginowi bez zmian, jako uporządkowaną listę posortowaną według ścieżki. Host odczytuje bajty jako nieprzezroczystą treść i ich nie parsuje. Nieobecne, gdy dołączenie nie deklaruje źródeł.
settingsobjectnieObiekt ustawień o dowolnej postaci, który host przekazuje pluginowi bez zmian. Host nie parsuje jego treści ani na nią nie reaguje. Nieobecny, gdy dołączenie nie deklaruje ustawień.

Dodatkowe właściwości są niedozwolone.

AnnotationTransformOutput

Kształt odpowiedzi emitowanej przez plugin annotation-transform: lista wstrzyknięć adnotacji, które host stosuje do wskazanych celów. Host stosuje wyłącznie dodania adnotacji do istniejących współrzędnych celów, z których każde przenosi wartość, jaką autor mógłby zapisać w tej adnotacji — ciąg znaków albo obiekt podkluczy; wstrzyknięcie wskazujące nieistniejącą współrzędną lub przenoszące wartość o jakimkolwiek innym kształcie jawnie zatrzymuje kompilację.

WłaściwośćTypWymaganaOpis
injectionsAnnotationInjection[]takWstrzyknięcia adnotacji do zastosowania, w kolejności. Każde wskazuje istniejącą współrzędną celu oraz klucz adnotacji i wartość, które należy tam dodać.
errorstringnieKomunikat o niepowodzeniu ustawiany, gdy gość został uruchomiony, ale nie mógł ukończyć operacji; nieobecny w razie powodzenia. Host przedstawia obecny błąd jako nieudane wywołanie pluginu.

Dodatkowe właściwości są niedozwolone.

AnnotationTarget

Jeden rozwiązany cel wstrzykiwania, do którego plugin może wstrzykiwać adnotacje: jego ścieżka granicy i nazwa komponentu oraz zestaw adnotacji, który komponent już posiada.

WłaściwośćTypWymaganaOpis
boundary_pathstringtakRozdzielona ukośnikami ścieżka granicy, pod którą komponent znajduje się w encji Release.
component_namestringtakNazwa komponentu w obrębie jego granicy.
annotationsmapa string lub object lub nulltakAdnotacje, które encja Release zapisuje na samym komponencie, kluczowane kluczem adnotacji w kolejności zapisu. Każda wartość jest tym, co zapisał autor: ciągiem znaków, obiektem podkluczy we własnej kolejności zapisu albo null tam, gdzie komponent rezygnuje z adnotacji, którą w przeciwnym razie by odziedziczył. Każdy klucz jest obecny niezależnie od wartości, więc plugin może odróżnić adnotację, którą komponent już ma, od takiej, której nie ma, i dodać tylko brakujące.

Dodatkowe właściwości są niedozwolone.

AnnotationInjection

Jedna adnotacja do wstrzyknięcia do celu: współrzędna celu oraz klucz adnotacji i jej wartość.

WłaściwośćTypWymaganaOpis
boundary_pathstringtakRozdzielona ukośnikami ścieżka granicy komponentu docelowego. Musi wskazywać cel dostarczony przez hosta; nieznana współrzędna zatrzymuje kompilację.
component_namestringtakNazwa komponentu docelowego. Musi wskazywać cel dostarczony przez hosta; nieznana współrzędna zatrzymuje kompilację.
annotation_keystringtakKlucz adnotacji do dodania w komponencie docelowym.
annotation_valuestring lub objecttakWartość adnotacji, przenoszona jako jej JSON: ciąg znaków albo obiekt, którego klucze są podkluczami, a wpisy są tym, co autor może zapisać pod podkluczem adnotacji strukturalnej. Host odczytuje ją dokładnie tak, jak odczytuje tę samą wartość zapisaną na komponencie w encji Release, zachowując kolejność kluczy obiektu, dzięki czemu obiekt może zasilać powiązanie kierujące kilka podkluczy naraz, a ciąg znaków — powiązanie kierujące jeden. Null, lista, liczba, wartość logiczna i obiekt bez podkluczy są odrzucane ze wskazaniem wstrzyknięcia: wstrzyknięcie dodaje adnotację i nigdy jej nie usuwa ani z niej nie rezygnuje.

Dodatkowe właściwości są niedozwolone.

AnnotationSource

Jeden plik definicji przekazany pluginowi: jego ścieżka w postaci nazwy bazowej oraz treść pliku. Oba są przenoszone bez zmian; host nie parsuje treści.

WłaściwośćTypWymaganaOpis
pathstringtakNazwa bazowa pliku źródłowego. Host dostarcza wyłącznie nazwę bazową, nigdy bezwzględnej ścieżki hosta, dzięki czemu komunikat jest przenośny i deterministyczny.
contentstringtakTreść pliku źródłowego, przenoszona bez zmian jako nieprzezroczysty ciąg znaków.

Dodatkowe właściwości są niedozwolone.