Cahier des charges de l'API des extensions d'interface utilisateur du SDK Digital

Une fois le processus de génération terminé, l'interface de ligne de commande de Jutro placera les résultats de la génération dans le répertoire src/generated de votre application Jutro. Sur cette page, nous allons présenter la structure de haut niveau des résultats de la génération et indiquerons les modules disponibles pour un usage public.

Note: Les modules n'étant pas documentés ici ne sont pas destinés à une utilisation directe par les développeurs. Ils sont utilisés en interne et sont considérés comme des détails d'implémentation susceptibles d'être modifiés sans préavis.

Structure des résultats de la génération

La commande de génération de CLI Jutro crée deux répertoires après chaque SDK indiqué dans le fichier de configuration. Ils utilisent tous deux le nom de répertoire fourni lors de la génération, mais ils ont des chemins d'accès différents et des fonctionnalités différentes :

1. Les répertoires Digital SDK sont directement dans le chemin d'accès src/generated.

   Les applications utilisant les extensions d'interface utilisateur peuvent également accéder directement au SDK Digital, car le contenu de ces répertoires respecte les mêmes cahiers des charge que ceux décrits sur le site dédié à la documentation sur le SDK Digital. La seule exception est la fonction initSdkJutro, qui est générée exclusivement par la CLI Jutro.

2. Les répertoires des extensions d'interface utilisateur du SDK Digital se trouvent dans le sous-chemin /JutroUtils.

   Dans src/generated/JutroUtils/<sdk-name>, vous trouverez les extensions d'interface utilisateur du SDK Digital pour le SDK correspondant. Nous expliquerons ci-dessous le contrat API de ces extensions d'interface utilisateur.

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/

Modules d'extensions d'interface utilisateur du SDK Digital

Dans cette section, nous allons répertorier les modules disponibles dans les répertoires des extensions d'interface utilisateur du SDK Digital.

Module d'entité

Un répertoire d'entité sera généré dans les extensions d'interface utilisateur du SDK Digital pour chacune des entités disponibles dans le SDK Digital correspondant.

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

Ces répertoires d'entités contiennent un fichier d'index qui centralise toutes les exportations disponibles pour un usage public :

• Un fournisseur d'entité nommé <entity-name>Provider.
• Un crochet d'entité nommé use<entity-name>.
• Un ensemble de composants de champ nommé Field_<field-name>.
• Une série fieldsList qui comprend tous les composants de champs de l'entité.

Module JobLines

Si vous générez les extensions d'interface utilisateur du SDK Digital pour un SDK Digital qui inclut l'API job ou policy, un répertoire supplémentaire JobLines se trouvera dans le chemin correspondant à ces API.

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

Ce répertoire contient un fichier d'index qui centralise toutes les exportations disponibles pour un usage public dans votre application :

• Un composant JobLinesProvider.
• Un crochet useJobLines.

Pour en savoir plus sur l'utilisation des entités JobLines, reportez-vous à la page Utilisation des JobLines.

Module racine des extensions de l'interface utilisateur du SDK Digital

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

Le module racine des répertoires contenant les extensions d'interface utilisateur du SDK Digital exporte les types de TypeScript CoveragesListItem et FieldsListItem. Ces types sont utilisés en interne par d'autres exportations et ils peuvent être utiles lors de l'utilisation des extensions d'interface utilisateur du SDK Digital.