# BACKEND INVENTORY - {PROYECTO}
# Sistema: NEXUS v3.4 + SIMCO
#
# USO: Copiar a orchestration/inventarios/BACKEND_INVENTORY.yml
#      Documentar modulos, endpoints y arquitectura backend

metadata:
  version: "1.0.0"
  proyecto: "{PROYECTO}"
  framework: "NestJS"  # NestJS | Express | FastAPI
  lenguaje: "TypeScript"
  generado: "{FECHA}"
  actualizado: "{FECHA}"

configuracion:
  puerto: 3000
  base_path: "/api"
  version_api: "v1"
  swagger: true
  swagger_path: "/api/docs"

resumen:
  total_modulos: 0
  total_endpoints: 0
  total_entities: 0
  total_services: 0
  total_controllers: 0
  total_guards: 0
  total_interceptors: 0

modulos:
  - nombre: "app"
    path: "src/"
    tipo: "ROOT"
    descripcion: "Modulo raiz de la aplicacion"
    estado: "ACTIVO"

  - nombre: "{modulo_ejemplo}"
    path: "src/modules/{modulo_ejemplo}"
    tipo: "FEATURE"  # FEATURE | SHARED | CORE
    descripcion: ""
    estado: "ACTIVO"  # ACTIVO | DEPRECADO | EN_DESARROLLO

    entities:
      - nombre: "{Entity}Entity"
        archivo: "entities/{entity}.entity.ts"
        tabla: "{tabla}"

    controllers:
      - nombre: "{Entity}Controller"
        archivo: "{entity}.controller.ts"
        endpoints:
          - metodo: "GET"
            path: "/"
            descripcion: "Listar todos"
          - metodo: "GET"
            path: "/:id"
            descripcion: "Obtener por ID"
          - metodo: "POST"
            path: "/"
            descripcion: "Crear nuevo"
          - metodo: "PATCH"
            path: "/:id"
            descripcion: "Actualizar"
          - metodo: "DELETE"
            path: "/:id"
            descripcion: "Eliminar"

    services:
      - nombre: "{Entity}Service"
        archivo: "{entity}.service.ts"

    dtos:
      - Create{Entity}Dto
      - Update{Entity}Dto
      - "{Entity}ResponseDto"

shared:
  guards:
    - nombre: "JwtAuthGuard"
      archivo: "src/shared/guards/jwt-auth.guard.ts"

  interceptors:
    - nombre: "LoggingInterceptor"
      archivo: "src/shared/interceptors/logging.interceptor.ts"

  decorators: []

  pipes: []

rutas:
  src_base: "apps/backend/src/"
  modules_base: "apps/backend/src/modules/"
  shared_base: "apps/backend/src/shared/"
  config_base: "apps/backend/src/config/"

scripts:
  build: "npm run build"
  start: "npm run start:dev"
  test: "npm run test"
  lint: "npm run lint"

notas: |
  Documentar aqui informacion adicional sobre el backend.
  - Patrones utilizados
  - Convenciones de codigo
  - Dependencias importantes