API-Vertrag für Digital SDK UI Extensions

Sobald der Generierungsprozess abgeschlossen ist, legt die Jutro CLI die Generierungsergebnisse im Verzeichnis src/generated Ihrer Jutro-Anwendung ab. Auf dieser Seite werden wir die allgemeine Struktur der Generierungsergebnisse behandeln und die Module spezifizieren, die für die öffentliche Verwendung verfügbar sind.

Note: Die hier nicht dokumentierten Module sind nicht für die direkte Verwendung durch Entwickler vorgesehen. Sie werden intern verwendet und gelten als Implementierungsdetails, die ohne vorherige Ankündigung geändert werden können.

Struktur der Generierungsausgabe

Der Jutro-CLI-Generierungsbefehl erstellt nach jedem in der Konfigurationsdatei angegebenen SDK zwei Verzeichnisse. Beide verwenden den Verzeichnisnamen, der bei der Generierung angegeben wurde, befinden sich jedoch in unterschiedlichen Pfaden und bieten unterschiedliche Funktionen:

1. Die Digital SDK-Verzeichnisse befinden sich direkt im Pfad src/generated.

   Die Anwendungen, die UI Extensions verwenden, können auch direkt auf das Digital SDK zugreifen, da der Inhalt dieser Verzeichnisse denselben Verträgen unterliegt, die auf der dedizierten Digital SDK-Dokumentationsseite beschrieben werden. Die einzige Ausnahme ist die Funktion initSdkJutro, die ausschließlich über die Jutro CLI generiert wird.

2. Die Verzeichnisse der Digital SDK UI Extensions befinden sich im Unterpfad /JutroUtils.

   In src/generated/JutroUtils/<sdk-name> finden Sie die Digital SDK UI Extensions für das entsprechende SDK. In den folgenden Abschnitten wird der API-Vertrag dieser UI Extensions erläutert.

Example of the generated structure for a configuration file that includes two SDKs,
named `PcSdk` and `CcSdk`:

yourJutroApp/src/generated/
└── PcSdk/
└── CcSdk/
└── JutroUtils/
    ├── PcSdk/
    └── CcSdk/

Module für Digital SDK UI Extensions

In diesem Abschnitt werden die Module aufgelistet, die in den Verzeichnissen für Digital SDK UI Extensions verfügbar sind.

Entitäten-Modul

Für jede der Entitäten, die im entsprechenden Digital SDK verfügbar sind, wird in Digital SDK UI Extensions ein Entitätsverzeichnis generiert.

src/generated/JutroUtils/<your-sdk-name>/<api-name>/<entity-name>

Diese Entitätsverzeichnisse enthalten eine Indexdatei, die alle für die öffentliche Verwendung verfügbaren Exporte zentralisiert:

• Einen Entitätsanbieter mit der Bezeichnung <entity-name>Provider.
• Einen Entitäts-Hook mit der Bezeichnung use<entity-name>.
• Einen Satz Feldkomponenten mit der Bezeichnung Field_<field-name>.
• Ein fieldsList-Array, das alle Feldkomponenten der Entität enthält.

Modul JobLines

Wenn Sie die Digital SDK UI Extensions für ein Digital SDK generieren, das die API job oder policy enthält, befindet sich ein zusätzliches Verzeichnis JobLines in dem Pfad, der diesen APIs entspricht.

src/generated/JutroUtils/<your-sdk-name>/<api-name>/JobLines

Dieses Verzeichnis enthält eine Indexdatei, die alle Exporte zentralisiert, die alle in Ihrer Anwendung für die öffentliche Verwendung verfügbaren Exporte zentralisiert:

• Eine JobLinesProvider-Komponente.
• Ein useJobLines-Hook.

Weitere Informationen zum Arbeiten mit JobLines-Entitäten finden Sie auf der Seite Arbeiten mit JobLines.

Digital SDK UI Extensions-Stammmodul

src/generated/JutroUtils/<your-sdk-name>

Das Stammmodul der Verzeichnisse, die die Digital SDK UI Extensions enthalten, exportiert die TypeScript-Typen CoveragesListItem und FieldsListItem. Diese Typen werden intern von anderen Exporten verwendet und können bei der Arbeit mit den Digital SDK UI Extensions nützlich sein.