Contrato de la API de extensiones de la interfaz de usuario del SDK de Digital

Una vez que se completa el proceso de generación, la CLI de Jutro colocará los resultados de la generación en el directorio src/generated de su aplicación de Jutro. En esta página, abarcaremos la estructura general de los resultados de la generación y especificaremos los módulos de uso público.

Note: Los módulos no documentados aquí no están destinados al uso directo por parte de los desarrolladores. Se utilizan internamente y se consideran detalles de implementación sujetos a cambios sin previo aviso.

Estructura de salida de generación

El comando de generación Jutro CLI creará dos directorios después de cada SDK especificado en el archivo de configuración. Ambos utilizan el nombre del directorio proporcionado durante la generación, pero se encuentran en diferentes rutas y proporcionan diferentes funcionalidades:

1. Los directorios del SDK de Digital se encuentran directamente en la ruta src/generated.

   Las aplicaciones que utilizan las extensiones de interfaz de usuario también pueden acceder directamente al SDK de Digital, ya que el contenido de estos directorios se adhiere a los mismos contratos descritos en el sitio de documentación exclusivo del SDK de Digital. La única excepción es la función initSdkJutro, que se genera exclusivamente a través de Jutro CLI.

2. Los directorios de las extensiones de interfaz de usuario del SDK de Digital se encuentran en la ruta secundaria /JutroUtils.

   En src/generated/JutroUtils/<sdk-name>, encontrará las extensiones de la interfaz de usuario del SDK de Digital para el SDK correspondiente. Explicaremos el contrato de la API de estas extensiones de interfaz de usuario en las siguientes secciones.

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/

Módulos de extensiones de la interfaz de usuario del SDK de Digital

En esta sección, enumeraremos los módulos disponibles en los directorios de extensiones de la interfaz de usuario del SDK de Digital.

Módulo de entidad

Se generará un directorio de entidad en las extensiones de la interfaz de usuario del SDK de Digital para cada una de las entidades disponibles en el SDK de Digital correspondiente.

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

Estos directorios de entidades contienen un archivo índice que centraliza todas las exportaciones para uso público:

• Un proveedor de entidad denominado <entity-name>Provider.
• Un gancho de entidad denominado use<entity-name>.
• Un conjunto de componentes de campo denominado Field_<field-name>.
• Una matriz fieldsList que incluye todos los componentes de campo de la entidad.

Módulo de JobLines

Si está generando las extensiones de la interfaz de usuario del SDK de Digital para un SDK de Digital que incluye la API de job o de policy, habrá un directorio adicional JobLines ubicado en la ruta correspondiente a esas API.

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

Este directorio contiene un archivo índice que centraliza todas las exportaciones de uso público en su aplicación:

• Un componente JobLinesProvider.
• Un gancho useJobLines.

Para obtener más información sobre cómo trabajar con entidades JobLines, consulte la página Cómo trabajar con JobLines.

Módulo raíz de extensiones de la interfaz de usuario del SDK de Digital

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

El módulo raíz de los directorios que contienen extensiones de la interfaz de usuario del SDK de Digital exporta los tipos de TypeScript CoveragesListItem y FieldsListItem. Estos tipos son utilizados internamente por otras exportaciones y podrían ser útiles cuando se trabaja con extensiones de interfaz de usuario del SDK de Digital.