NgDocumentosCliente

Ng Documentos Cliente es un componente tipo modal para visualizar datos de las dcouemntos cliente.

Esta Libreria se generó con Angular CLI version 19.1.0.

Índice

• Pre-requisitos
• Arquitectura Hexagonal
• Estructura del proyecto
• Datos de entrada
• Configuración
• Como utilizar
• Licencia
• Autores

Pre-requisitos

Para que nuestro componente funcione debemos tener instalado las siguientes librerias.

• @angular/material
• ag-grid-angular

Arquitectura Hexagonal

La librería está diseñada con Hexagonal Architecture, lo que significa que separa las capas internas (dominio y aplicación) de las capas externas (infraestructura y adaptadores). Esto permite que la lógica de negocio sea independiente de los frameworks y herramientas específicas.

Estructura del proyecto

📂 ng-documentos-cliente
┣ 📂 lib
┃ ┣ 📂 domain                        # Lógica de negocio y modelos
┃ ┃ ┣ 📂 mappers                     # Mapeo de datos API a Domain y viceversa
┃ ┃ ┣ 📂 models                      # Modelos de datos
┃ ┃ ┗ 📂 usecase                     # Casos de uso (Aplicación de negocio)
┃ ┣ 📂 environment                   # Configuración de entorno
┃ ┣ 📂 helpers                       # Funciones auxiliares y utilidades
┃ ┣ 📂 infrastructure                # Comunicación con el exterior (Servicios, APIs, etc.)
┃ ┃ ┣ 📂 dto                         # Data Transfer Objects
┃ ┃ ┣ 📂 repositories                # Implementaciones de acceso a datos
┃ ┃ ┗ 📂 services                    # Servicios que interactúan con APIs externas
┃ ┣ 📂 entry-point                   # Adaptadores y puntos de entrada (controladores, etc.)
┃ ┣ 📂 modules                       # Módulos de la aplicación
┃ ┃ ┣ 📂 consulta-documentos-cliente # Módulo de trazabilidad
┃ ┃ ┗ 📂 shared                      # Componentes compartidos

Datos de entrada

Definición de atributos del [input] consulta-documentos-cliente-config para el correcto funcionamiento del dialog ng-documentos-cliente

| Atributo | Descripción | |----------------------------|-----------------------------------------------------------------------------| | accessToken (string) | Valor del token de autorización para consumir la api de documentos cliente. | | host (string) | Host donde se consultara las documentos cliente. | | idRemesa (string) | Identificador de la remesa | | numeroRemesa (string) | Numero de remesa | | widthDialog? (string) | (Opcional) Ancho del dialog. Default: 660px |
| heightTable? (string) | (Opcional) Alto de la tabla. Default: 250px | | camposAOcultar? (string[]) | (Opcional) Campos que no se deseen mostrar en la tabla |

Nombre de los campos que se pueden ocultar:

• tipoDocumento
• numeroDocumento
• fechaDocumento

Configuración

En el archivo app.gateway-config.ts, agrega lo siguiente para definir la configuración del Gateway:

import { libDocumentosClienteGateWayConfig } from 'ng-documentos-cliente';

export const gateWayConfig: Provider | EnvironmentProviders = [
  libDocumentosClienteGateWayConfig // Providers lib Docmuentos Cliente
];

En el archivo app.config.ts, agrega la siguiente configuración:

provideAnimationsAsync(), //Animation Angular
//HttpClient
  provideHttpClient(
    withFetch(),
  ),
  NgConsultaDocumentosClienteDialog, // Providers Dialog de consulta de documentos cliente
  gateWayConfig // Provider app.gateway-config.ts
  //Tambien se puede colocar directamente el Provider de la libreria
  //libDocumentosClienteGateWayConfig //De esta manera

Como utilizar

Importación de la libreria

import { NgConsultaDocumentosClienteDialog } from 'ng-documentos-cliente';

Declaración e Inyección de la libreria

constructor(
  private readonly ngConsultaDocumentosClienteDialog: NgConsultaDocumentosClienteDialog
) {}

Abrir el dialog

const configConsultaDocumentosCliente: ConsultaDocumentosClienteConfigDto = {
  accessToken: 'ey23232323',
  host: environment.HOST,
  idRemesa: "2323223232323232332",
  numeroRemesa: '232323232'
}
this.ngConsultaDocumentosClienteDialog.open(configConsultaDocumentosCliente);

Licencia

Este componente es software propietario de TCC. Queda restringido a proyectos internos y no puede distribuirse ni reutilizarse fuera de la organización.

Autores

• Camiliño Andrés Calle Coavas - Analista Desarrollador - Softcaribbean
• Fabio Miguel Lengua Pastrana - Analista Desarrollador - Softcaribbean