ng-unidades 1.0.1 → 1.2.0

package/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 2025 TCC
+
+All Rights Reserved.
+Este software es propiedad de TCC y no puede ser
+copiado, distribuido ni modificado sin autorización expresa.

package/README.md

@@ -4,7 +4,26 @@ Ng Unidades es un componente tipo modal para visualizar datos de las unidades y
 
 Esta Libreria se generó con [Angular CLI](https://github.com/angular/angular-cli) version 19.1.0.
 
-### Pre-requisitos 📋
+
+## Índice
+
+- [Pre-requisitos](#pre-requisitos)
+- [Arquitectura Hexagonal](#arquitectura-hexagonal)
+- [Estructura del proyecto](#estructura-del-proyecto)
+- [Datos relevante para la libreria](#datos-relevante-para-la-libreria)
+- [Consulta de unidades](#consulta-de-unidades)
+  - [Datos de entrada del componente de unidades](#datos-de-entrada-del-componente-de-unidades)
+- [Consulta de trazabilidad unidades](#consulta-de-trazabilidad-unidades)
+  - [Datos de entrada del componente de trazabilidad](#datos-de-entrada-del-componente-de-trazabilidad)
+- [Configuración](#configuración)
+- [Como utilizar dialog de consulta de unidades](#como-utilizar-dialog-de-consulta-de-unidades)
+- [Como utilizar dialog de consulta de trazabilidad](#como-utilizar-dialog-de-consulta-de-trazabilidad)
+- [Licencia](#licencia)
+- [Autores](#autores)
+
+---
+
+### Pre-requisitos
 
 Para que nuestro componente funcione debemos tener instalado las siguientes librerias.
 
@@ -34,7 +53,7 @@ y herramientas específicas.
 ┃ ┃ ┣ 📂 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
+┃ ┣ 📂 modules                 # Módulos de la aplicación
 ┃ ┃ ┣ 📂 consulta-trazabilidad # Módulo de trazabilidad
 ┃ ┃ ┣ 📂 consulta-unidades     # Módulo de unidades
 ┃ ┃ ┗ 📂 shared                # Componentes compartidos
@@ -42,7 +61,7 @@ y herramientas específicas.
 
 ### Datos relevante para la libreria
 
-Esta libreria se separa en 2 componentes principales:
+Esta libreria se separa en 3 componentes principales:
 
 * Consulta de unidades
 
@@ -52,28 +71,35 @@ Esta libreria se separa en 2 componentes principales:
 
   En este componente se visualizan los datos de la trazabilidad de la unidad seleccionada.
 
+* Consulta imagenes
+
+  En este componente se visualizan las imagenes de la unidad seleccionada.
+
 >Nota: Estos componentes están relacionados, ya que la consulta de unidades permite seleccionar una unidad específica,
-y luego la consulta de trazabilidad muestra los detalles de esa unidad seleccionada. Pero tambien se pueden usar de 
-manera independiente puesto que si solo necesito saber la trazabilidad de una unidad, puedo usar el componente de trazabilidad.
+>y luego la consulta de trazabilidad muestra los detalles de esa unidad seleccionada. Pero tambien se pueden usar de 
+>manera independiente puesto que si solo necesito saber la trazabilidad de una unidad, puedo usar el componente de trazabilidad.
+>Lo mismo aplica para las imagenes.
 
 ### Consulta de unidades
 
-#### Datos de entrada de la libreria
+#### Datos de entrada del componente de unidades
 
 Definición de atributos del [input] `consulta-unidades-config` para el correcto funcionamiento del `dialog ng-consulta-unidades`
 
-| Atributo                      | Descripción                                                       |
-|-------------------------------|-------------------------------------------------------------------|
-| accessToken (string)          | Valor del token de autorización para consumir la api de unidades. |
-| host (string)                 | Host donde se consultara las unidades.                            |
-| idRemesa (string)             | Identificador de la remesa                                        |
-| numeroRemesa (string)         | Numero de remesa                                                  |
-| widthDialog? (string)         | (Opcional) Ancho del dialog. Default: 1080px                      |                                              |
-| heightTable? (string)         | (Opcional) Alto de la tabla. Default: 350px                       |
-| camposAOcultar? (string[])    | (Opcional) Campos que no se deseen mostrar en la tabla            |
-
+| Atributo                               | Descripción                                                            |
+|----------------------------------------|------------------------------------------------------------------------|
+| accessToken (string)                   | Valor del token de autorización para consumir la api de unidades.      |
+| host (string)                          | Host donde se consultara las unidades.                                 |
+| idRemesa (string)                      | Identificador de la remesa                                             |
+| numeroUnidad (string)                  | Numero de remesa                                                       |
+| widthDialog? (string)                  | (Opcional) Ancho del dialog. Default: 1080px                           |                                              
+| heightTable? (string)                  | (Opcional) Alto de la tabla. Default: 350px                            |
+| camposAOcultar? (string[])             | (Opcional) Campos que no se deseen mostrar en la tabla                 |
+| iconosAOcultar? (string[])             | (Opcional) Iconos que no se deseen mostrar en la tabla                 |
+| camposAOcultarTrazabilidad? (string[]) | (Opcional) Campos que no se deseen mostrar en la tabla de trazabilidad |
 
 Nombre de los campos que se pueden ocultar:
+* acciones
 * codigoUnidad
 * tipoUnidad
 * claseEmpaque
@@ -84,9 +110,14 @@ Nombre de los campos que se pueden ocultar:
 * movilEntrega
 * certificacion
 
+Nombre de los iconos que se pueden ocultar:
+* verTrazabilidad
+* verNovedad
+* verImagen
+
 ### Consulta de trazabilidad unidades
 
-#### Datos de entrada de la libreria
+#### Datos de entrada del componente de trazabilidad
 
 Definición de atributos del [input] `consulta-trazabilidad-config` para el correcto funcionamiento del `dialog ng-consulta-trazabilidad`
 
@@ -114,7 +145,32 @@ Nombre de los campos que se pueden ocultar:
 * usuario
 * observaciones
 
-### Configuración 🔧
+### Consulta de imagenes
+
+#### Datos de entrada del componente de unidades
+
+Definición de atributos del [input] `consulta-imagenes-config` para el correcto funcionamiento del `dialog ng-consulta-imagenes`
+
+| Atributo                               | Descripción                                                            |
+|----------------------------------------|------------------------------------------------------------------------|
+| accessToken (string)                   | Valor del token de autorización para consumir la api de unidades.      |
+| host (string)                          | Host donde se consultara las unidades.                                 |
+| numeroUnidad (string)                  | Numero de unidad                                                       |
+| imagenes (DatosImagen[])               | Lista de los datos de las imagenes                                     |
+
+### DatosImagen
+
+Definición de atributos del [input] `DatosImagen` para el correcto funcionamiento del `dialog ng-consulta-imagenes`
+
+| Atributo                   | Descripción                |
+|----------------------------|----------------------------|
+| imageObservations (string) | Observaciones de la imagen |
+| caption (string)           | Descripcion de la imagen   |
+| url (string)               | Url de la imagen           |
+| nombreFoto (string)        | Nombre de la foto          |
+
+
+### Configuración
 
 En el archivo `app.gateway-config.ts`, agrega lo siguiente para definir la configuración del Gateway:
 
@@ -136,13 +192,14 @@ provideAnimationsAsync(), //Animation Angular
   ),
   NgConsultaUnidadesDialog, // Providers Dialog de consulta de unidades
   NgConsultaTrazabilidadDialog, // Providers Dialog de consulta de trazabilidad
+  NgConsultaImagenesDialog, // Providers Dialog de consulta de trazabilidad
   gateWayConfig // Provider app.gateway-config.ts
 //Tambien se puede colocar directamente el Provider de la libreria
 //libCreateGateWayConfig //De esta manera
 ```
 
 >Nota: Solo se debe agregar el Provider de la libreria que se va a utilizar.
->No es necesario agregar los 2 si no se va a utilizar.
+>No es necesario agregar los 3 si no se va a utilizar.
 
 Como se mencionó anteriormente, el Provider de la librería se puede agregar directamente en el archivo `app.config.ts.`
 Sin embargo, es recomendable definirlo en el archivo de Providers del proyecto consumidor para mantener un mejor orden y organización.
@@ -203,8 +260,57 @@ const configConsultaTrazabilidad: ConsultaTrazabilidadConfigDto = {
 this.ngConsultaTrazabilidadDialog.open(configConsultaTrazabilidad);
 ```
 
+### Como utilizar dialog de consulta de imagenes
+
+Importación de la libreria
+
+```ts
+import { NgConsultaImagenesDialog } from 'ng-unidades';
+```
+
+Declaración e Inyección de la libreria
+
+```ts
+constructor(
+  private readonly ngConsultaImagenesDialog: NgConsultaImagenesDialog
+) {}
+```
+
+Abrir el dialog
+
+```ts
+const datosImagenes: DatosImagen[] = [
+  {
+    imageObservations: 'Imagen tomada en bodega central',
+    caption: "caption1",
+    url: "data:image/jpeg;base64,/9j/",
+    nombreFoto: "imagen1.jpg"
+  },
+  {
+    imageObservations: 'Imagen 2 tomada en bodega central',
+    caption: "caption2",
+    url: "data:image/jpeg;base64,/9j/",
+    nombreFoto: "imagen2.jpg"
+  }
+]
+
+const configConsultaImagenes: ConsultaImagenesConfigDto = {
+  accessToken: '123',
+  host: environment.HOST,
+  numeroUnidad: '446843278',
+  imagenes: datosImagenes
+}
+
+this.ngConsultaImagenesDialog.open(configConsultaImagenes);
+```
+
+### 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 ✒️
+### Autores
 
 * **Camiliño Andrés Calle Coavas** - *Analista Desarrollador* - [Softcaribbean](https://www.softcaribbean.com/)
 * **Fabio Miguel Lengua Pastrana** - *Analista Desarrollador* - [Softcaribbean](https://www.softcaribbean.com/)