react-ecosistema-unp 2.5.0-pre.1 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +354 -25
- package/dist/{AppList-DORGpC4I.js → AppList-CNtk-CBh.js} +56 -55
- package/dist/auth/hooks/useFinalizarSesion.js +12 -12
- package/dist/auth/services/FinSesionService.js +10 -11
- package/dist/cards/tarjeta/nuevo-elemento/NuevoElemento.js +1 -1
- package/dist/cards/tarjeta-info/TarjetaInfo.js +1 -1
- package/dist/data/tarjeta-datos/TarjetaDatos.js +1 -1
- package/dist/{index-BqaJxgOF.js → index-HaNVi1BU.js} +8 -8
- package/dist/lib/accessibility/barra-accesibilidad/BarraAccesibilidad.d.ts +1 -1
- package/dist/lib/assets/animations/loadingDuck.json.d.ts +1 -1
- package/dist/lib/utils/logger/logger.d.ts +25 -0
- package/dist/lib/utils/modal-radicados/ModalDocumento.d.ts +1 -1
- package/dist/lib/utils/sanitizar-html/sanitizarHtml.d.ts +12 -0
- package/dist/loadingDuck-Deggug5u.js +27 -0
- package/dist/shared/app-list/AppList.js +4 -3
- package/dist/shared/iconos-sistema/IconosSistema.js +1 -1
- package/dist/shared/iconos-sistema/logout-button/LogoutButton.js +1 -1
- package/dist/shared/menu-lateral/MenuLateral.js +5 -3
- package/dist/shared/notificacion-usuario/NotificacionUsuario.js +194 -745
- package/dist/shared/notificacion-usuario/services/notificacionesService.js +52 -51
- package/dist/shared/user-profile-icon/UserProfileIcon.js +17 -17
- package/dist/shared/ventana-tabs/VentanaTabs.js +1 -1
- package/dist/tables/custom-data-table/CustomDataTable.js +4 -2
- package/dist/tables/custom-data-table-split/CustomDataTableSplit.js +4 -2
- package/dist/tables/eco-data-table/components/EcoBandejaEncabezado.js +3 -2
- package/dist/tables/eco-data-table/components/EcoDataTable/EcoDataTable.js +1 -1
- package/dist/tables/tabla-registros/buscador/Buscador.js +1 -1
- package/dist/tables/tabla-registros/encabezado-tabla/EncabezadoTabla.js +3 -2
- package/dist/tables/tabla-registros/modal-v2/EcoModal.js +1 -1
- package/dist/tables/tabla-registros/tabla/Tabla.js +1 -1
- package/dist/ui/alertas/AlertaFormulario.js +1 -1
- package/dist/ui/animacion/Animacion.js +1 -1
- package/dist/ui/contenido-modal/ContenidoModal.js +1 -1
- package/dist/ui/contenido-modal/ContenidoModalv0.1.js +1 -1
- package/dist/ui/contenido-modal-v2/ContenidoModalV2.js +1 -1
- package/dist/ui/contenido-modal-v2/ModalV2Menu.js +1 -1
- package/dist/ui/icono-tooltip/IconoTooltip.js +1 -1
- package/dist/ui/items-modal/ItemsModal.js +1 -1
- package/dist/ui/nav-formularios-lateral/NavFormulariosLateral.js +1 -1
- package/dist/ui/notificacion-popover-v2/NotificacionPopoverV2.js +80 -79
- package/dist/ui/status-filter-bar/StatusFilterBar.js +1 -1
- package/dist/ui/status-semaphore/StatusSemaphore.js +1 -1
- package/dist/ui/stepper-v2/StepperV2.js +1 -1
- package/dist/utils/components/ProtectedRoute.js +25 -26
- package/dist/utils/components/UserRoute.js +14 -16
- package/dist/utils/eco-provider/EcoContext.js +4 -2
- package/dist/utils/fetch-data/useFetchData.js +60 -59
- package/dist/utils/logger/logger.js +20 -0
- package/dist/utils/modal-radicados/AuxRadicadosComponents/TarjetaRadicado.js +20 -18
- package/dist/utils/modal-radicados/DocumentoVisorEstado.js +4 -3
- package/dist/utils/modal-radicados/ModalDocumento.js +1 -1
- package/dist/utils/modal-radicados/ModalRadicado.js +82 -80
- package/dist/utils/sanitizar-html/sanitizarHtml.js +1486 -0
- package/dist/utils/unp-historico/FetchHistorico.js +6 -5
- package/dist/utils/unp-historico/UnpHistorico.js +3 -2
- package/dist/utils/websocket-manager/websocket.js +19 -18
- package/package.json +28 -18
- package/dist/lib/utils/fetch/fetchInterceptor.d.ts +0 -7
- package/dist/lib/utils/fetch/fingerprintService.d.ts +0 -27
- package/dist/loadingDuck-Diu5KD6X.js +0 -27
- package/dist/utils/fetch/fetchInterceptor.js +0 -98
- package/dist/utils/fetch/fingerprintService.js +0 -1749
package/README.md
CHANGED
|
@@ -1,10 +1,74 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
<
|
|
4
|
-
<a href="https://www.npmjs.com/package/react-ecosistema-unp"><img title="npm version" src="https://badgen.net/npm/v/react-ecosistema-unp?label=latest"></a>
|
|
5
|
-
</span>
|
|
3
|
+
<img src="lib/assets/img/ecosistema/logo_escudo_azul.svg" alt="Escudo del Ecosistema de Información" width="72" />
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
<br />
|
|
6
|
+
|
|
7
|
+
# react-ecosistema-unp
|
|
8
|
+
|
|
9
|
+
**Librería de componentes React del Ecosistema de Información**
|
|
10
|
+
|
|
11
|
+
*Unidad Nacional de Protección (UNP)*
|
|
12
|
+
|
|
13
|
+
<br />
|
|
14
|
+
|
|
15
|
+
[](https://www.npmjs.com/package/react-ecosistema-unp)
|
|
16
|
+
[](https://react.dev)
|
|
17
|
+
[](https://www.typescriptlang.org)
|
|
18
|
+
[](https://vite.dev)
|
|
19
|
+
[](https://getbootstrap.com)
|
|
20
|
+
|
|
21
|
+
<br />
|
|
22
|
+
|
|
23
|
+
Componentes, proveedores y utilidades compartidos por las aplicaciones del Ecosistema de Información: ventanas, tablas, tarjetas, modales, autenticación y accesibilidad.
|
|
24
|
+
|
|
25
|
+
<br />
|
|
26
|
+
|
|
27
|
+
| | |
|
|
28
|
+
|---|---|
|
|
29
|
+
| **Paquete** | `react-ecosistema-unp` (npm) |
|
|
30
|
+
| **Formato** | Módulos ES con tipos de TypeScript |
|
|
31
|
+
| **Rama de integración** | `pre-main` |
|
|
32
|
+
| **Rama de publicación** | `main` |
|
|
33
|
+
| **Organismo** | UNP — Ecosistema de Información |
|
|
34
|
+
|
|
35
|
+
</div>
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Tabla de contenidos
|
|
40
|
+
|
|
41
|
+
- [Descripción general](#descripción-general)
|
|
42
|
+
- [Instalación](#instalación)
|
|
43
|
+
- [Configuración inicial](#configuración-inicial)
|
|
44
|
+
- [Módulos de importación](#módulos-de-importación)
|
|
45
|
+
- [Documentación de componentes](#documentación-de-componentes)
|
|
46
|
+
- [Stack tecnológico](#stack-tecnológico)
|
|
47
|
+
- [Dependencias y licenciamiento](#dependencias-y-licenciamiento)
|
|
48
|
+
- [Arquitectura del paquete](#arquitectura-del-paquete)
|
|
49
|
+
- [Estructura del proyecto](#estructura-del-proyecto)
|
|
50
|
+
- [Desarrollo local](#desarrollo-local)
|
|
51
|
+
- [Scripts disponibles](#scripts-disponibles)
|
|
52
|
+
- [Integración continua y publicación](#integración-continua-y-publicación)
|
|
53
|
+
- [Licencia](#licencia)
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Descripción general
|
|
58
|
+
|
|
59
|
+
`react-ecosistema-unp` reúne los componentes y utilidades que comparten las aplicaciones del Ecosistema de Información de la UNP, para que todas tengan la misma apariencia y resuelvan igual las tareas comunes.
|
|
60
|
+
|
|
61
|
+
### Qué incluye
|
|
62
|
+
|
|
63
|
+
- **Marco de las aplicaciones:** ventanas, pestañas, menú lateral, encabezados y pie institucional.
|
|
64
|
+
- **Tablas y bandejas:** tablas con paginación, selección, reordenamiento y paginación desde el servidor.
|
|
65
|
+
- **Tarjetas y formularios:** tarjetas de edición y de lectura, secciones, alertas y validación de formularios.
|
|
66
|
+
- **Modales:** modales genéricos y los de radicados y documentos.
|
|
67
|
+
- **Autenticación:** proveedor de sesión, rutas protegidas e interceptor de peticiones.
|
|
68
|
+
- **Notificaciones y tiempo real:** avisos en pantalla y conexión por WebSocket.
|
|
69
|
+
- **Accesibilidad:** barra de accesibilidad.
|
|
70
|
+
|
|
71
|
+
---
|
|
8
72
|
|
|
9
73
|
## Instalación
|
|
10
74
|
|
|
@@ -12,15 +76,25 @@ La Librería del Ecosistema de Información es una colección de componentes reu
|
|
|
12
76
|
npm install react-ecosistema-unp@latest
|
|
13
77
|
```
|
|
14
78
|
|
|
15
|
-
|
|
79
|
+
La aplicación que la instala debe aportar estas dependencias, que la librería declara como pares:
|
|
80
|
+
|
|
81
|
+
| Paquete | Versiones admitidas |
|
|
82
|
+
|---------|---------------------|
|
|
83
|
+
| `react` y `react-dom` | 18, 19 |
|
|
84
|
+
| `react-router-dom` | 6, 7 |
|
|
85
|
+
| `lottie-react` | 2.4.1 o posterior de la serie 2 |
|
|
86
|
+
|
|
87
|
+
> **Nota:** la resolución de módulos del proyecto debe ser `bundler`. Sin ella, TypeScript no encuentra las entradas del paquete.
|
|
16
88
|
|
|
17
89
|
```json
|
|
18
90
|
"moduleResolution": "bundler"
|
|
19
91
|
```
|
|
20
92
|
|
|
93
|
+
---
|
|
94
|
+
|
|
21
95
|
## Configuración inicial
|
|
22
96
|
|
|
23
|
-
|
|
97
|
+
Toda aplicación que use la librería debe envolverse con `EcoProvider`. Este proveedor prepara la autenticación, la conexión por WebSocket y las notificaciones en pantalla que usan los demás componentes.
|
|
24
98
|
|
|
25
99
|
```tsx
|
|
26
100
|
import { EcoProvider } from 'react-ecosistema-unp/utils';
|
|
@@ -34,25 +108,280 @@ function App() {
|
|
|
34
108
|
}
|
|
35
109
|
```
|
|
36
110
|
|
|
37
|
-
|
|
111
|
+
| Propiedad | Tipo | Por defecto | Descripción |
|
|
112
|
+
|-----------|------|-------------|-------------|
|
|
113
|
+
| `children` | `ReactNode` | — | Contenido de la aplicación. |
|
|
114
|
+
| `showToaster` | `boolean` | `true` | Monta el contenedor de notificaciones. Se pasa `false` si la aplicación monta el suyo. |
|
|
38
115
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
* [Tablas y modales](docs/tables.md)
|
|
43
|
-
* [Utilidades](docs/utils.md)
|
|
44
|
-
* [Autenticación](docs/auth.md)
|
|
45
|
-
* [Datos](docs/data.md)
|
|
46
|
-
* [Accesibilidad](docs/accessibility.md)
|
|
116
|
+
Debe quedar en el nivel más alto del árbol, por fuera del enrutador. Más detalle en [docs/utils/EcoProvider.md](docs/utils/EcoProvider.md).
|
|
117
|
+
|
|
118
|
+
---
|
|
47
119
|
|
|
48
120
|
## Módulos de importación
|
|
49
121
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
|
58
|
-
|
|
122
|
+
Los componentes se importan desde la entrada de su módulo, no desde la raíz del paquete: la raíz no exporta nada.
|
|
123
|
+
|
|
124
|
+
```tsx
|
|
125
|
+
import { VentanaLienzo } from 'react-ecosistema-unp/shared';
|
|
126
|
+
import { EcoDataTable } from 'react-ecosistema-unp/tables';
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
| Módulo | Importación | Contenido principal |
|
|
130
|
+
|--------|-------------|---------------------|
|
|
131
|
+
| UI | `react-ecosistema-unp/ui` | `Encabezado`, `EncabezadoV2`, `Subtitulo`, `Logo`, `Paginador`, `PaginadorV2`, `StepperV2`, `Animacion`, `ContenedorVentana`, `IconoTooltip`, `ItemsModal`, `ContenidoModal`, `ContenidoModalV2`, `EcoModal`, `CustomModal`, `SeccionFormulario`, `AlertaFormulario`, `SmartTextArea`, `StatusSemaphore`, `StatusFilterBar`, `TableSkeleton`, `DatosBasicosCard`, `NavFormulariosLateral`, `CardGestionLateral`, `NotificacionBellV2`, `ResumenEvaluacionTable`, `EcoFooter` |
|
|
132
|
+
| Shared | `react-ecosistema-unp/shared` | `VentanaLienzo`, `VentanaTabs`, `TabVentana`, `VentanaSesion`, `VentanaSesionMarca`, `FooterInstitucionalSesion`, `IconosSistema` |
|
|
133
|
+
| Cards | `react-ecosistema-unp/cards` | `Tarjeta`, `SeccionTarjeta`, `ContenedorTarjeta`, `NuevoElemento`, `TarjetaLectura`, `SeccionTarjetaLectura`, `TarjetaInfo` |
|
|
134
|
+
| Tables | `react-ecosistema-unp/tables` | `EcoDataTable` y sus piezas (`EcoDataTablePaginator`, `EcoBandejaEncabezado`, `EcoDataTableSelectionToolbar`…), los hooks `useEcoTablePagination`, `useEcoTableSelection`, `useEcoTableReorder` y `useEcoTableServerPages`, `CustomDataTable`, `CustomDataTableSplit`, `CustomTableToolbar`, `TablaRegistros` |
|
|
135
|
+
| Utils | `react-ecosistema-unp/utils` | `EcoProvider`, `ProtectedRoute`, `UserRoute`, `useFetchData`, `useFormValidation`, `CaptchaEcosistema`, `useWebSocket`, `ModalRadicado`, `ModalDocumento`, `VisorDocumento`, `UnpHistorico`, `Toaster`, `formatDate` |
|
|
136
|
+
| Auth | `react-ecosistema-unp/auth` | `AuthProvider`, `useAuth`, `auth` |
|
|
137
|
+
| Accessibility | `react-ecosistema-unp/accessibility` | `BarraAccesibilidad` |
|
|
138
|
+
| Data | `react-ecosistema-unp/data` | `DocsEcosistema` |
|
|
139
|
+
| Estilos | `react-ecosistema-unp/styles/EcoStyles.css` | Hoja de estilos base del ecosistema |
|
|
140
|
+
|
|
141
|
+
La lista completa de lo que exporta cada módulo está en el archivo de su mismo nombre dentro de `lib/` (por ejemplo, `lib/ui.ts`).
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## Documentación de componentes
|
|
146
|
+
|
|
147
|
+
Cada guía describe las propiedades de los componentes del módulo y trae ejemplos de uso.
|
|
148
|
+
|
|
149
|
+
| Guía | Contenido |
|
|
150
|
+
|------|-----------|
|
|
151
|
+
| [Elementos UI](docs/ui.md) | Encabezados, paginadores, animaciones, modales y piezas de formulario |
|
|
152
|
+
| [Componentes compartidos](docs/shared.md) | Ventanas, pestañas, menú lateral e iconos del sistema |
|
|
153
|
+
| [Tarjetas](docs/cards.md) | Tarjetas de edición, de lectura e informativas |
|
|
154
|
+
| [Tablas y modales](docs/tables.md) | `EcoDataTable`, tablas anteriores y modales de tabla |
|
|
155
|
+
| [Utilidades](docs/utils.md) | Proveedor, rutas, peticiones, validaciones, captcha y WebSocket |
|
|
156
|
+
| [Autenticación](docs/auth.md) | Sesión, rutas protegidas y uso del gateway |
|
|
157
|
+
| [Datos](docs/data.md) | Catálogo de documentos del ecosistema |
|
|
158
|
+
| [Accesibilidad](docs/accessibility.md) | Barra de accesibilidad |
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## Stack tecnológico
|
|
163
|
+
|
|
164
|
+
| Categoría | Tecnología |
|
|
165
|
+
|-----------|------------|
|
|
166
|
+
| Biblioteca UI | React 18 y 19 (dependencia par) |
|
|
167
|
+
| Lenguaje | TypeScript 5.6 |
|
|
168
|
+
| Compilación | Vite 6 en modo librería (`tsc -b ./tsconfig.lib.json && vite build`) |
|
|
169
|
+
| Tipos | `vite-plugin-dts` genera los `.d.ts` |
|
|
170
|
+
| Estilos | Bootstrap 5.3 · React Bootstrap · CSS por componente, incluido con `vite-plugin-lib-inject-css` |
|
|
171
|
+
| Enrutamiento | React Router DOM 6 y 7 (dependencia par) |
|
|
172
|
+
| Notificaciones | Sileo · React Toastify · SweetAlert2 |
|
|
173
|
+
| Animaciones | Lottie React (dependencia par) |
|
|
174
|
+
| Seguridad | DOMPurify para sanear HTML · Turnstile para el captcha |
|
|
175
|
+
| Catálogo de componentes | Storybook 8, solo en local |
|
|
176
|
+
| Análisis estático | ESLint 9 con `typescript-eslint` |
|
|
177
|
+
| Pruebas | Vitest, en la rama `test` |
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## Dependencias y licenciamiento
|
|
182
|
+
|
|
183
|
+
Versiones **según la instalación del proyecto** (`node_modules`), no el rango declarado en `package.json`.
|
|
184
|
+
|
|
185
|
+
### Dependencias que se instalan con el paquete
|
|
186
|
+
|
|
187
|
+
| Librería | Versión | Propósito | Licencia |
|
|
188
|
+
|----------|---------|-----------|----------|
|
|
189
|
+
| bootstrap | 5.3.3 | Estilos base | MIT |
|
|
190
|
+
| react-bootstrap | 2.10.9 | Componentes de Bootstrap para React | MIT |
|
|
191
|
+
| react-icons | 5.4.0 | Iconografía | MIT |
|
|
192
|
+
| react-select | 5.10.1 | Listas de selección | MIT |
|
|
193
|
+
| react-toastify | 11.0.3 | Notificaciones | MIT |
|
|
194
|
+
| sileo | 0.1.5 | Notificaciones | MIT |
|
|
195
|
+
| sweetalert2 | 11.26.24 | Cuadros de confirmación | MIT |
|
|
196
|
+
| dompurify | 3.4.16 | Saneado de HTML | **MPL-2.0 o Apache-2.0** |
|
|
197
|
+
| jwt-decode | 4.0.0 | Lectura del token de sesión | MIT |
|
|
198
|
+
| @marsidev/react-turnstile | 1.1.0 | Captcha | MIT |
|
|
199
|
+
| @fingerprintjs/fingerprintjs | 5.0.1 | Identificación del navegador | MIT |
|
|
200
|
+
|
|
201
|
+
### Dependencias pares
|
|
202
|
+
|
|
203
|
+
Las aporta la aplicación que instala la librería.
|
|
204
|
+
|
|
205
|
+
| Librería | Versión instalada aquí | Rango admitido | Licencia |
|
|
206
|
+
|----------|------------------------|----------------|----------|
|
|
207
|
+
| react · react-dom | 19.0.0 | `>=18.0.0 <=20.0.0` | MIT |
|
|
208
|
+
| react-router-dom | 7.18.4 | `>=6.0.0 <=8.0.0` | MIT |
|
|
209
|
+
| lottie-react | 2.4.2 | `^2.4.1` | MIT |
|
|
210
|
+
|
|
211
|
+
### Dependencias de desarrollo
|
|
212
|
+
|
|
213
|
+
No se publican ni llegan a las aplicaciones.
|
|
214
|
+
|
|
215
|
+
| Librería | Versión | Propósito | Licencia |
|
|
216
|
+
|----------|---------|-----------|----------|
|
|
217
|
+
| vite | 6.4.4 | Compilación y servidor de desarrollo | MIT |
|
|
218
|
+
| @vitejs/plugin-react | 4.3.4 | Soporte de React en Vite | MIT |
|
|
219
|
+
| vite-plugin-dts | 5.1.2 | Generación de tipos | MIT |
|
|
220
|
+
| vite-plugin-lib-inject-css | 2.2.1 | Inclusión del CSS de cada componente | MIT |
|
|
221
|
+
| rollup-plugin-visualizer | 7.0.1 | Informe de tamaño del paquete (`stats.html`) | MIT |
|
|
222
|
+
| glob | 11.1.0 | Descubrimiento de entradas en la compilación | **BlueOak-1.0.0** |
|
|
223
|
+
| typescript | 5.6.3 | Tipado estático | Apache-2.0 |
|
|
224
|
+
| eslint · @eslint/js | 9.39.4 | Análisis estático | MIT |
|
|
225
|
+
| typescript-eslint | 8.71.1 | Reglas de ESLint para TypeScript | MIT |
|
|
226
|
+
| eslint-plugin-react-hooks · eslint-plugin-react-refresh · eslint-plugin-storybook | 5.1.0 · 0.4.18 · 0.11.2 | Reglas de ESLint | MIT |
|
|
227
|
+
| globals | 15.14.0 | Catálogo de variables globales | MIT |
|
|
228
|
+
| storybook y paquetes `@storybook/*` | 8.6.18 | Catálogo de componentes | MIT |
|
|
229
|
+
| @chromatic-com/storybook | 3.2.4 | Complemento de Storybook | MIT |
|
|
230
|
+
| @types/react · @types/react-dom · @types/node | 18.3.18 · 18.3.5 · 22.10.10 | Definiciones de tipos | MIT |
|
|
231
|
+
|
|
232
|
+
### Licencias distintas de MIT
|
|
233
|
+
|
|
234
|
+
- `dompurify` se publica con licencia doble, **MPL-2.0 o Apache-2.0**.
|
|
235
|
+
- `typescript` se publica bajo **Apache-2.0**.
|
|
236
|
+
- `glob` se publica bajo **BlueOak-1.0.0**. Solo se usa al compilar.
|
|
237
|
+
|
|
238
|
+
Las tres son permisivas o de copyleft limitado al propio archivo, y compatibles con el uso que se les da aquí.
|
|
239
|
+
|
|
240
|
+
### Dependencias comerciales
|
|
241
|
+
|
|
242
|
+
No se identifican dependencias comerciales de pago en el `package.json` del proyecto.
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
## Arquitectura del paquete
|
|
247
|
+
|
|
248
|
+
- **Una entrada por módulo.** Cada archivo de la raíz de `lib/` (`ui.ts`, `shared.ts`, `tables.ts`…) es una entrada pública declarada en `exports` de `package.json`.
|
|
249
|
+
- **Un archivo de salida por archivo fuente.** La compilación no agrupa todo en un único archivo: cada componente queda en su propio módulo, de modo que la aplicación solo carga lo que importa.
|
|
250
|
+
- **El CSS viaja con su componente.** Al importar un componente se importa también su hoja de estilos; no hace falta cargar una hoja global para que se vea bien.
|
|
251
|
+
- **React, React Router y Lottie quedan fuera del paquete.** Los aporta la aplicación, para que no existan dos copias (dos enrutadores en la misma página no funcionan).
|
|
252
|
+
- **Solo se publica `dist/`.** El código fuente, las guías, las historias y la configuración no forman parte del paquete.
|
|
253
|
+
|
|
254
|
+
```text
|
|
255
|
+
lib/ui.ts ──────────┐
|
|
256
|
+
lib/shared.ts ──────┤ ┌── dist/ui.js, dist/shared.js, … (entradas)
|
|
257
|
+
lib/tables.ts ──────┼── tsc + vite build ──┼── dist/<módulo>/… (un archivo por componente)
|
|
258
|
+
lib/utils.ts ───────┤ ├── dist/assets/*.css (estilos)
|
|
259
|
+
lib/… ──────────────┘ └── dist/lib/*.d.ts (tipos)
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
## Estructura del proyecto
|
|
265
|
+
|
|
266
|
+
```text
|
|
267
|
+
react-ecosistema-unp/
|
|
268
|
+
├── lib/ # Código de la librería (lo que se compila y publica)
|
|
269
|
+
│ ├── accessibility/ # Barra de accesibilidad
|
|
270
|
+
│ ├── auth/ # Proveedor de sesión, hook y servicio de usuario
|
|
271
|
+
│ ├── cards/ # Tarjetas
|
|
272
|
+
│ ├── data/ # Catálogo de documentos
|
|
273
|
+
│ ├── shared/ # Ventanas, pestañas, menú lateral
|
|
274
|
+
│ ├── tables/ # EcoDataTable y tablas anteriores
|
|
275
|
+
│ ├── ui/ # Encabezados, modales, paginadores, formularios
|
|
276
|
+
│ ├── utils/ # EcoProvider, rutas, peticiones, validaciones, WebSocket
|
|
277
|
+
│ ├── assets/ # Animaciones, fuentes, iconos e imágenes
|
|
278
|
+
│ ├── styles/ # Estilos base
|
|
279
|
+
│ └── *.ts # Una entrada pública por módulo
|
|
280
|
+
├── docs/ # Guías de uso por módulo y por componente
|
|
281
|
+
├── src/
|
|
282
|
+
│ ├── stories/ # Historias de Storybook
|
|
283
|
+
│ ├── pages/ · App.tsx # Aplicación de prueba para el desarrollo
|
|
284
|
+
│ └── doc/ # Notas de mantenimiento (configuración de npm, hallazgos, pruebas)
|
|
285
|
+
├── .storybook/ # Configuración de Storybook
|
|
286
|
+
├── .github/workflows/ci.yml # Integración continua
|
|
287
|
+
├── .npmrc # Configuración de npm del repositorio
|
|
288
|
+
├── vite.config.ts # Compilación en modo librería
|
|
289
|
+
└── tsconfig*.json
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
|
|
294
|
+
## Desarrollo local
|
|
295
|
+
|
|
296
|
+
### Requisitos previos
|
|
297
|
+
|
|
298
|
+
- **Node.js** 20, o 22 en adelante.
|
|
299
|
+
- **npm** 11.10 o posterior, para que se aplique la espera de siete días sobre versiones nuevas que define el `.npmrc`. Con una versión anterior npm muestra un aviso y sigue funcionando. Ver [src/doc/npmrc.md](src/doc/npmrc.md).
|
|
300
|
+
|
|
301
|
+
### Puesta en marcha
|
|
302
|
+
|
|
303
|
+
```bash
|
|
304
|
+
# Instalación de dependencias
|
|
305
|
+
npm install
|
|
306
|
+
|
|
307
|
+
# Aplicación de prueba con recarga en caliente
|
|
308
|
+
npm run dev
|
|
309
|
+
|
|
310
|
+
# Catálogo de componentes en http://localhost:6006
|
|
311
|
+
npm run storybook
|
|
312
|
+
|
|
313
|
+
# Compilación de la librería (deja dist/)
|
|
314
|
+
npm run build
|
|
315
|
+
|
|
316
|
+
# Análisis estático
|
|
317
|
+
npm run lint
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Probar un cambio en una aplicación antes de publicarlo
|
|
321
|
+
|
|
322
|
+
```bash
|
|
323
|
+
# En la librería: compila y empaqueta
|
|
324
|
+
npm run build
|
|
325
|
+
npm pack
|
|
326
|
+
|
|
327
|
+
# En la aplicación: instala el archivo generado
|
|
328
|
+
npm install ../react-ecosistema-unp/react-ecosistema-unp-<versión>.tgz
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
Los archivos `.tgz` no se versionan.
|
|
332
|
+
|
|
333
|
+
---
|
|
334
|
+
|
|
335
|
+
## Scripts disponibles
|
|
336
|
+
|
|
337
|
+
| Script | Descripción |
|
|
338
|
+
|--------|-------------|
|
|
339
|
+
| `npm run dev` | Servidor de desarrollo de Vite con la aplicación de prueba |
|
|
340
|
+
| `npm run build` | `tsc -b ./tsconfig.lib.json` y luego `vite build`; deja `dist/` y el informe `stats.html` |
|
|
341
|
+
| `npm run preview` | Servidor de vista previa de Vite |
|
|
342
|
+
| `npm run lint` | ESLint sobre el proyecto |
|
|
343
|
+
| `npm run storybook` | Catálogo de componentes en el puerto 6006 |
|
|
344
|
+
| `npm run build-storybook` | Genera el catálogo estático en `.storybook/.storybook-build` |
|
|
345
|
+
|
|
346
|
+
`prepublishOnly` ejecuta `npm run build` antes de cada publicación.
|
|
347
|
+
|
|
348
|
+
---
|
|
349
|
+
|
|
350
|
+
## Integración continua y publicación
|
|
351
|
+
|
|
352
|
+
### Ramas
|
|
353
|
+
|
|
354
|
+
| Rama | Uso |
|
|
355
|
+
|------|-----|
|
|
356
|
+
| `main` | Versión publicada |
|
|
357
|
+
| `pre-main` | Integración previa a `main` |
|
|
358
|
+
| `test` | Pruebas unitarias (la carpeta `test/` solo existe aquí) |
|
|
359
|
+
|
|
360
|
+
Los cambios llegan a `pre-main` y a `main` por *pull request*.
|
|
361
|
+
|
|
362
|
+
### GitHub Actions
|
|
363
|
+
|
|
364
|
+
`.github/workflows/ci.yml` se ejecuta en cada envío y en cada *pull request* hacia `main` y `pre-main`. Usa el flujo central de librerías del ecosistema, que compila el paquete y hace las revisiones de seguridad: búsqueda de secretos, auditoría de dependencias y análisis estático. No publica ni despliega nada.
|
|
365
|
+
|
|
366
|
+
### Publicación en npm
|
|
367
|
+
|
|
368
|
+
La publicación es manual. Antes de publicar se sube la versión en `package.json`; `npm publish` ejecuta la compilación por su cuenta y envía solo `dist/`.
|
|
369
|
+
|
|
370
|
+
| Etiqueta de npm | Uso |
|
|
371
|
+
|-----------------|-----|
|
|
372
|
+
| `latest` | Versión estable |
|
|
373
|
+
| `pre` | Versiones previas, para probar antes de una estable |
|
|
374
|
+
|
|
375
|
+
### Documentación de componentes
|
|
376
|
+
|
|
377
|
+
El catálogo de Storybook se usa solo en local; no se publica en ningún sitio.
|
|
378
|
+
|
|
379
|
+
---
|
|
380
|
+
|
|
381
|
+
## Licencia
|
|
382
|
+
|
|
383
|
+
Proyecto de la **Unidad Nacional de Protección (UNP)**.
|
|
384
|
+
|
|
385
|
+
Todos los derechos reservados. El `package.json` no declara una licencia de uso.
|
|
386
|
+
|
|
387
|
+
Las dependencias de código abierto y sus licencias están en la sección [Dependencias y licenciamiento](#dependencias-y-licenciamiento).
|