failproofai 0.0.6-beta.2 → 0.0.6-beta.4

package/.next/standalone/docs/es/architecture.mdx

@@ -1,332 +0,0 @@
----
-title: Arquitectura
-description: "Cómo funcionan internamente el manejador de hooks, la carga de configuración y la evaluación de políticas"
-icon: sitemap
----
-
-Este documento explica cómo funciona failproofai internamente: cómo el sistema de hooks intercepta las llamadas a herramientas del agente, cómo se carga y combina la configuración, cómo se evalúan las políticas y cómo el panel de control monitoriza la actividad del agente.
-
----
-
-## Descripción general
-
-failproofai tiene dos subsistemas independientes:
-
-1. **Manejador de hooks** — Un subproceso CLI rápido que Claude Code invoca en cada llamada a herramienta del agente. Evalúa las políticas y devuelve una decisión.
-2. **Monitor de agentes (Panel de control)** — Una aplicación web Next.js para monitorizar sesiones de agentes y gestionar políticas.
-
-Ambos subsistemas comparten archivos de configuración en `~/.failproofai/` y en el directorio `.failproofai/` del proyecto, pero se ejecutan como procesos separados y se comunican únicamente a través del sistema de archivos.
-
----
-
-## Manejador de hooks
-
-### Integración con Claude Code
-
-Cuando ejecutas `failproofai policies --install`, escribe entradas como esta en `~/.claude/settings.json`:
-
-```json
-{
-  "hooks": {
-    "PreToolUse": [
-      {
-        "matcher": "",
-        "hooks": [
-          {
-            "type": "command",
-            "command": "failproofai --hook PreToolUse"
-          }
-        ]
-      }
-    ],
-    "PostToolUse": [ ... ]
-  }
-}
-```
-
-Claude Code invoca entonces `failproofai --hook PreToolUse` como subproceso antes de cada llamada a herramienta, pasando un payload JSON por stdin.
-
-### Formato del payload
-
-```json
-{
-  "session_id": "abc123",
-  "transcript_path": "/home/user/.claude/projects/myproject/sessions/abc123.jsonl",
-  "cwd": "/home/user/myproject",
-  "permission_mode": "default",
-  "hook_event_name": "PreToolUse",
-  "tool_name": "Bash",
-  "tool_input": { "command": "sudo apt install nodejs" }
-}
-```
-
-Para eventos `PostToolUse`, el payload también contiene `tool_result` con la salida de la herramienta.
-
-El manejador impone un límite de 1 MB en stdin. Los payloads que superen este tamaño se descartan y todas las políticas permiten implícitamente.
-
-### Formato de respuesta
-
-**Denegar (PreToolUse):**
-```json
-{
-  "hookSpecificOutput": {
-    "permissionDecision": "deny",
-    "permissionDecisionReason": "Blocked by failproofai: sudo command blocked"
-  }
-}
-```
-
-**Denegar (PostToolUse):**
-```json
-{
-  "hookSpecificOutput": {
-    "additionalContext": "Blocked by failproofai because: API key detected in output"
-  }
-}
-```
-
-**Instruir (cualquier evento excepto Stop):**
-```json
-{
-  "hookSpecificOutput": {
-    "additionalContext": "Instruction from failproofai: Verify tests pass before committing."
-  }
-}
-```
-
-**Instruir en evento Stop:**
-- Código de salida: `2`
-- El motivo se escribe en stderr (no en stdout)
-
-**Permitir:**
-- Código de salida: `0`
-- stdout vacío
-
-**Permitir con mensaje:**
-
-`allow(message)` permite que una política envíe contexto informativo de vuelta a Claude incluso cuando la operación está permitida. El manejador de hooks escribe el siguiente JSON en **stdout** (no en un archivo de configuración — esta es la respuesta del manejador a Claude Code, igual que las respuestas de deny e instruct anteriores):
-
-```json
-// Written to stdout by the hook handler process
-{
-  "hookSpecificOutput": {
-    "additionalContext": "All CI checks passed on branch 'feat/my-feature'."
-  }
-}
-```
-- Código de salida: `0` (la operación está permitida)
-- Cuando varias políticas devuelven `allow` con un mensaje, sus mensajes se unen con saltos de línea en una sola cadena `additionalContext`
-- Si ninguna política proporciona un mensaje, stdout queda vacío (igual que antes)
-
-### Pipeline de procesamiento
-
-`src/hooks/handler.ts` implementa el pipeline completo:
-
-```text
-stdin JSON
-  → parse payload (max 1 MB)
-  → extract session metadata (session_id, cwd, tool_name, tool_input, etc.)
-  → readMergedHooksConfig(cwd)    ← merges project + local + global config
-  → register enabled builtin policies with resolved params
-  → load custom policies from customPoliciesPath (if set)
-  → register custom policies into policy registry
-  → evaluate all policies (builtins first, then custom)
-      → first deny short-circuits
-      → instruct decisions accumulate
-      → allow messages accumulate
-  → write JSON decision to stdout
-  → persist event to ~/.failproofai/hook-activity.jsonl
-  → exit
-```
-
-Todo el proceso se ejecuta en menos de 100 ms para payloads típicos sin ninguna llamada a LLM.
-
----
-
-## Carga de configuración
-
-`src/hooks/hooks-config.ts` implementa la carga de configuración en tres ámbitos.
-
-```text
-[1] {cwd}/.failproofai/policies-config.json        ← proyecto  (máxima prioridad)
-[2] {cwd}/.failproofai/policies-config.local.json  ← local
-[3] ~/.failproofai/policies-config.json             ← global   (mínima prioridad)
-```
-
-Lógica de combinación:
-- `enabledPolicies` — unión sin duplicados de los tres archivos
-- `policyParams` — clave por política; gana íntegramente el primer archivo que la defina
-- `customPoliciesPath` — gana el primer archivo que lo defina
-- `llm` — gana el primer archivo que lo defina
-
-El panel de control web utiliza `readHooksConfig()` (solo global) para lectura y escritura, ya que no se invoca con un cwd de proyecto.
-
----
-
-## Evaluación de políticas
-
-`src/hooks/policy-evaluator.ts` ejecuta las políticas en orden.
-
-Para cada política:
-
-1. Busca el esquema `params` de la política (si tiene uno).
-2. Lee `policyParams[policy.name]` de la configuración combinada.
-3. Combina los valores proporcionados por el usuario sobre los valores predeterminados del esquema para producir `ctx.params`.
-4. Llama a `policy.fn(ctx)` con el contexto resuelto.
-5. Si el resultado es `deny`, se detiene inmediatamente y devuelve esa decisión.
-6. Si el resultado es `instruct`, acumula el mensaje y continúa.
-7. Si el resultado es `allow`, continúa con la siguiente política.
-
-Tras ejecutar todas las políticas:
-- Si se devolvió algún `deny`, emite la respuesta de deny.
-- Si se recopilaron respuestas `instruct`, emite una única respuesta instruct con todos los mensajes unidos.
-- En caso contrario, emite una respuesta allow (stdout vacío, exit 0).
-
----
-
-## Políticas integradas
-
-`src/hooks/builtin-policies.ts` define las 26 políticas integradas como objetos `BuiltinPolicyDefinition`:
-
-```typescript
-interface BuiltinPolicyDefinition {
-  name: string;
-  description: string;
-  fn: (ctx: PolicyContext) => PolicyResult;
-  match: {
-    events: HookEventType[];
-    tools?: string[];
-  };
-  defaultEnabled: boolean;
-  category: string;
-  beta?: boolean;
-  params?: PolicyParamsSchema;
-}
-```
-
-Las políticas que aceptan `params` declaran un `PolicyParamsSchema` con tipos y valores predeterminados para cada parámetro. El evaluador de políticas inyecta los valores resueltos en `ctx.params` antes de llamar a `fn`. Las funciones de política leen `ctx.params` sin comprobaciones de nulo porque los valores predeterminados siempre se aplican primero.
-
-La coincidencia de patrones dentro de las políticas utiliza tokens de comando analizados (argv), no coincidencia de cadenas sin procesar. Esto evita la elusión mediante inyección de operadores de shell (p. ej., un patrón para `sudo systemctl status *` no puede eludirse añadiendo `; rm -rf /` al comando).
-
----
-
-## Políticas personalizadas
-
-`src/hooks/custom-hooks-registry.ts` implementa un registro respaldado por `globalThis`:
-
-```typescript
-const REGISTRY_KEY = "__failproofai_custom_hooks__";
-
-export const customPolicies = {
-  add(hook: CustomHook): void { ... }
-};
-
-export function getCustomHooks(): CustomHook[] { ... }
-export function clearCustomHooks(): void { ... }  // used in tests
-```
-
-`src/hooks/custom-hooks-loader.ts` carga el archivo de políticas del usuario:
-
-1. Lee `customPoliciesPath` de la configuración; omite si no existe.
-2. Resuelve a ruta absoluta; comprueba que el archivo existe.
-3. Reescribe todas las importaciones `from "failproofai"` a la ruta dist real para que `customPolicies` resuelva al mismo registro `globalThis`.
-4. Reescribe recursivamente las importaciones locales transitivas para garantizar la compatibilidad con ESM.
-5. Escribe archivos `.mjs` temporales e importa el archivo de entrada con `import()`.
-6. Llama a `getCustomHooks()` para recuperar los hooks registrados.
-7. Limpia todos los archivos temporales en un bloque `finally`.
-
-Ante cualquier error (archivo no encontrado, error de sintaxis, fallo de importación), el error se registra en `~/.failproofai/hook.log` y el cargador devuelve un array vacío. Las políticas integradas no se ven afectadas.
-
-Las políticas personalizadas se evalúan después de todas las políticas integradas. Un `deny` de una política personalizada sigue cortocircuitando las demás políticas personalizadas (pero en ese punto todas las integradas ya han sido ejecutadas).
-
----
-
-## Registro de actividad
-
-Tras cada evento de hook, el manejador añade una línea JSONL a `~/.failproofai/hook-activity.jsonl`:
-
-```json
-{
-  "timestamp": "2026-04-06T12:34:56.789Z",
-  "sessionId": "abc123",
-  "eventType": "PreToolUse",
-  "toolName": "Bash",
-  "policyName": "block-sudo",
-  "decision": "deny",
-  "reason": "sudo command blocked by failproofai",
-  "durationMs": 12
-}
-```
-
-Una línea por política que tomó una decisión distinta de allow. Las decisiones allow no se registran (para mantener el archivo pequeño).
-
----
-
-## Arquitectura del panel de control
-
-El panel de control es una aplicación **Next.js 16** que utiliza el App Router con React Server Components y Server Actions.
-
-```text
-app/
-  layout.tsx                  ← Diseño raíz (tema, telemetría, nav)
-  projects/page.tsx           ← Componente servidor: lista todos los proyectos Claude
-  project/[name]/page.tsx     ← Componente servidor: lista sesiones de un proyecto
-  project/[name]/session/
-    [sessionId]/page.tsx      ← Componente servidor: renderiza el visor de sesión
-  policies/page.tsx           ← Componente cliente: gestión de políticas + registro de actividad
-  actions/
-    get-hooks-config.ts       ← Leer configuración + lista de políticas
-    update-hooks-config.ts    ← Activar/desactivar política
-    update-policy-params.ts   ← Actualizar parámetros de política
-    get-hook-activity.ts      ← Paginar/buscar en el registro de actividad
-    install-hooks-web.ts      ← Instalar/eliminar hooks desde el navegador
-  api/
-    download/[project]/[session]/route.ts   ← Exportar sesión como ZIP/JSONL
-```
-
-**Flujo de datos:**
-
-- Los componentes de página llaman a `lib/projects.ts` y `lib/log-entries.ts` para leer datos de proyectos y sesiones directamente desde el sistema de archivos (sin capa de API para lecturas).
-- La página de políticas usa Server Actions para todas las mutaciones (activar/desactivar, actualizar parámetros, instalar/eliminar).
-- El visor de sesiones analiza el formato de transcripción JSONL de Claude y renderiza una línea de tiempo de mensajes y llamadas a herramientas.
-
-**Decisiones de diseño clave:**
-
-- Sin base de datos — todo el estado persistente está en archivos planos (`~/.failproofai/`, `~/.claude/projects/`).
-- Server Actions para mutaciones — no se necesita una API REST para operaciones CRUD.
-- React Server Components para páginas de lectura — carga inicial más rápida, sin bundle de cliente para la obtención de datos.
-- Componentes cliente solo donde se necesita interactividad (activación de políticas, búsqueda de actividad, visor de registros).
-
----
-
-## Estructura de archivos
-
-```text
-failproofai/
-├── bin/
-│   └── failproofai.mjs           # Enrutador CLI (hook / dashboard / install / etc.)
-├── src/hooks/
-│   ├── handler.ts                # Pipeline de eventos de hook
-│   ├── builtin-policies.ts       # 26 definiciones de políticas
-│   ├── policy-evaluator.ts       # Motor de ejecución de políticas
-│   ├── policy-registry.ts        # Registro y búsqueda de políticas
-│   ├── policy-types.ts           # Interfaces TypeScript
-│   ├── hooks-config.ts           # Carga de configuración multi-ámbito
-│   ├── custom-hooks-registry.ts  # Registro de hooks respaldado por globalThis
-│   ├── custom-hooks-loader.ts    # Cargador ESM para hooks JS de usuario
-│   ├── manager.ts                # Operaciones de instalar / eliminar / listar
-│   ├── install-prompt.ts         # Prompt interactivo de selección de políticas
-│   ├── hook-logger.ts            # Registro en hook.log
-│   ├── hook-activity-store.ts    # Persistir actividad en hook-activity.jsonl
-│   └── llm-client.ts             # Cliente API LLM (para políticas con IA)
-├── app/                          # Panel de control Next.js (páginas + server actions)
-├── lib/                          # Utilidades compartidas
-│   ├── projects.ts               # Enumerar proyectos Claude desde el sistema de archivos
-│   ├── log-entries.ts            # Analizar el formato JSONL de transcripción de Claude
-│   ├── paths.ts                  # Resolver rutas del sistema
-│   └── ...
-├── components/                   # Componentes React UI compartidos
-├── contexts/                     # Proveedores de contexto React (tema, auto-refresco, telemetría)
-├── examples/                     # Archivos de hooks personalizados de ejemplo
-└── __tests__/                    # Pruebas unitarias y E2E
-```