Files
sam-portal/README.md
T
Nurfog 1a891c3751 refactor: validadores compartidos y componentes de UI extraídos
- src/lib/validators.ts centraliza regex y validaciones (module name,
  subdominio, slug, repoUrl, safeNext) usados por las rutas API y login,
  con tests en validators.test.ts
- DeployStatus, HelpdeskUsage y PagosUsage se extraen de las páginas
  /upload y /m/[name] a componentes propios
- README actualizado con la arquitectura y el contrato de /api/modules
2026-10-13 11:41:45 -03:00

69 lines
3.2 KiB
Markdown

# SAM Portal (Portal IT)
Índice de aplicaciones SAM + portal de gestión IT. Next.js 16 + Bootstrap 5 + Boxicons.
- **Índice público**: https://sam.devops.norteamericano.cl (aplicaciones integradas por sección)
- **Portal IT** (login): https://it.sam.devops.norteamericano.cl (tablero, gestión y tableros por módulo)
## Rutas
| Ruta | Auth | Descripción |
|------|------|-------------|
| `/` | no | Índice: módulos visibles por sección |
| `/login` | no | Ingreso IT (estilo legacy, USUARIO=idUsuario + CLAVE) |
| `/tablero` | sí | Tablero IT: estado global, carga por app (docker stats), servicios base |
| `/m/:name` | sí | Tablero del módulo (Portal IT redirige al tablero) |
| `/upload` | sí | Integrar módulo (categoría, tipo, visibilidad) |
| `/actualizar` | sí | Redeploy + webhook + toggle visibilidad |
| `/eliminar` | sí | Baja de módulos (con/sin código) |
| `/correo` | sí | Claves de correo por módulo (`POST /api/email/modules`, banco `mail.*`) |
| `/correo/plantillas` | sí | Plantillas del banco `mail.templates` (listar, crear, editar, activar) |
| `/api/modules` | GET público sanitizado / POST sí | Proxy al deployer: GET filtra visibles sin repoUrl ni logs |
| `/api/stats`, `/api/modules/:name/verify`, `/api/inventory` | sí | Proxy/lecturas del deployer (token server-side) |
| `/api/deployer/*` | sí | Proxy genérico al deployer (segmentos validados) |
| `/api/auth` (POST) | rate-limit 10/min por IP | Sesión HMAC 12h en cookie httpOnly |
| `/api/me` | — | Sesión actual (email) |
## Auth IT
Login contra el backend (`POST /api/Auth/it-login`, tabla `sige_sam_v3.usuario`,
clave en texto plano o SHA256) + allowlist `IT_USERS` (solo esos correos entran).
```bash
# Env del contenedor (las inyecta el deployer al registrar)
DEPLOYER_URL=http://sam-deployer:3010
DEPLOYER_TOKEN=<token>
NEXT_PUBLIC_API_URL=https://api.devops.norteamericano.cl
IT_USERS=usuario1@norteamericano.cl,usuario2@norteamericano.cl
IT_SESSION_SECRET=<openssl rand -hex 24>
# Cuenta de servicio helpdesk (usuario sige real con rol admin) para
# administrar claves de correo desde /correo (solo servidor):
HELPDESK_SERVICE_USER=<idUsuario>
HELPDESK_SERVICE_PASS=<clave>
# SAM_API_URL=https://api.devops.norteamericano.cl # default prod
```
## Desarrollo
```bash
pnpm install
pnpm dev # http://localhost:3000
pnpm lint && pnpm typecheck && pnpm test && pnpm build
```
## Arquitectura
- `/` y `/tablero` son Server Components (caché 15s/30s en el servidor,
isla cliente para revalidar). El resto de vistas IT son client components
con stores `useSyncExternalStore` (`src/lib/store.ts`, `src/lib/correo.ts`).
- El inventario SAM.API (`src/lib/api-inventory.ts`) solo se importa en
`src/app/api/inventory/route.ts`: nunca viaja al navegador.
- Secretos (`DEPLOYER_TOKEN`, `IT_SESSION_SECRET`, `HELPDESK_SERVICE_PASS`)
solo se usan en route handlers y `*-server.ts` (verificado: nada
server-side llega al bundle cliente).
El deploy a producción (.4) es vía push a `main` del repo + rebuild del
contenedor (`portal-frontend`). El módulo está registrado en el deployer
(categoría `sam`, subdominio `sam`); sus pushes ya no autodespliegan solos
(ver deployer `state.json` en .4).