@david-huanca/sga-core

Paquete Core del Sistema de Gestión Académica (SGA). Contiene toda la lógica de negocio, servicios, repositorios, validadores y tipos compartidos.

Instalación

En un Monorepo (Recomendado)

Si estás usando npm workspaces, el paquete ya está disponible:

{
  "dependencies": {
    "@david-huanca/sga-core": "*"
  }
}

Como Paquete NPM

npm install @david-huanca/sga-core

Desde Git (Para proyectos externos)

{
  "dependencies": {
    "@david-huanca/sga-core": "git+https://github.com/david-huanca/sga-nextjs.git#packages/core"
  }
}

Uso

Importar Servicios

import { UserService, ClassroomService } from "@david-huanca/sga-core";
import { PrismaClient } from "@prisma/client";

const prisma = new PrismaClient();
const userService = new UserService(prisma);
const classroomService = new ClassroomService(prisma);

// Usar los servicios
const users = await userService.getAllUsers();
const user = await userService.getUserById(1);

Importar Validadores

import { createUserSchema, updateUserSchema } from "@david-huanca/sga-core";

// Validar datos
const validatedData = createUserSchema.parse(userData);

Importar Errores

import { NotFoundError, ValidationError } from "@david-huanca/sga-core";

try {
  const user = await userService.getUserById(999);
} catch (error) {
  if (error instanceof NotFoundError) {
    // Manejar error 404
  }
}

Importar Tipos

import type { ApiResponse, UserWithRelations } from "@david-huanca/sga-core";

const response: ApiResponse<UserWithRelations> = {
  success: true,
  data: user,
};

Estructura

packages/core/
├── src/
│   ├── services/        # Servicios de negocio
│   ├── repositories/    # Repositorios de datos
│   ├── errors/          # Errores personalizados
│   ├── types/           # Tipos compartidos
│   ├── validators/      # Validadores Zod
│   └── index.ts         # Exportaciones públicas
├── package.json
└── tsconfig.json

Desarrollo

Build

npm run build

Esto genera los archivos compilados en dist/.

Desarrollo con Watch

npm run dev

Compila en modo watch para desarrollo.

Requisitos

• Node.js 18+
• TypeScript 5+
• @prisma/client (peer dependency)

API

UserService

• getUserById(id: number): Obtiene un usuario por ID
• getAllUsers(): Obtiene todos los usuarios
• getUsersByType(userType: UserType): Obtiene usuarios por tipo
• createUser(input: CreateUserInput): Crea un nuevo usuario
• updateUser(id: number, input: UpdateUserInput): Actualiza un usuario
• deleteUser(id: number): Elimina un usuario

ClassroomService

• getClassroomById(id: number): Obtiene una clase por ID
• getAllClassrooms(): Obtiene todas las clases
• getClassroomsByTeacher(teacherId: number): Obtiene clases por profesor
• getClassroomsByStudent(studentId: number): Obtiene clases por estudiante
• getClassroomsByProgram(programId: number): Obtiene clases por programa
• createClassroom(input: CreateClassroomInput): Crea una nueva clase
• updateClassroom(id: number, input: UpdateClassroomInput): Actualiza una clase
• deleteClassroom(id: number): Elimina una clase
• addStudentToClassroom(classroomId: number, userId: number): Agrega estudiante
• removeStudentFromClassroom(classroomId: number, userId: number): Remueve estudiante
• updateStudentScore(classroomId: number, userId: number, score: number, comment?: string): Actualiza calificación

Licencia

ISC