Rachas

Endpoints para seguimiento y gestión de rachas de actividad.

Modelos de Datos

El siguiente modelo de Prisma pertenece al schema gamification:

Streak

model Streak {
  id            String     @id @default(cuid())
  userProfileId String     @map("user_profile_id")
  goalId        String?    @map("goal_id")
  type          StreakType

  currentStreak Int @default(0) @map("current_streak")
  longestStreak Int @default(0) @map("longest_streak")
  totalDays     Int @default(0) @map("total_days")

  lastActivityDate DateTime? @map("last_activity_date")
  streakStartDate  DateTime? @map("streak_start_date")

  freezesUsed      Int @default(0) @map("freezes_used")
  freezesAvailable Int @default(0) @map("freezes_available")

  isActive Boolean @default(true) @map("is_active")

  userProfile UserProfile @relation(fields: [userProfileId], references: [id], onDelete: Cascade)
  goal        Goal?       @relation(fields: [goalId], references: [id], onDelete: Cascade)

  createdAt DateTime @default(now()) @map("created_at")
  updatedAt DateTime @updatedAt @map("updated_at")

  @@unique([userProfileId, type, goalId])
  @@map("streaks")
  @@schema("gamification")
}

StreakType (Enum)

enum StreakType {
  WORKOUT_STREAK
  GOAL_STREAK
  ATTENDANCE_STREAK
  CLASS_STREAK

  @@schema("gamification")
}

Lógica de Rachas

Las rachas se actualizan automáticamente al registrar progreso en un objetivo:

• Día consecutivo: currentStreak++
• Día no consecutivo (1-3 días): Usa freeze si disponible
• Más de 3 días: Reinicia a 1

Endpoints

Obtener Rachas

Obtener rachas del usuario.

• URL: /api/v1/gamification/streaks
• Método: GET
• Autenticación Requerida: Sí

Descripción Interna

Este endpoint obtiene las rachas del usuario:

1. Filtros disponibles:

   • type: Tipo de racha (GOAL_STREAK, WORKOUT_STREAK, etc.)
   • isActive: Solo rachas activas
   • goalId: Filtrar por objetivo específico

2. Incluye información del goal asociado (id, title, type)

3. Ordenado por currentStreak descendente

Parámetros de Consulta de Solicitud

• type: Tipo de racha
• isActive: Filtrar rachas activas
• goalId: Filtrar por objetivo
• page: Número de página
• limit: Resultados por página

Respuesta

{
  "data": [
    {
      "id": "...",
      "type": "WORKOUT_STREAK",
      "currentStreak": 15,
      "longestStreak": 30,
      "totalDays": 120,
      "lastActivityDate": "2023-10-27T00:00:00Z",
      "streakStartDate": "2023-10-12T00:00:00Z",
      "freezesUsed": 2,
      "freezesAvailable": 3,
      "isActive": true,
      "goal": {
        "id": "...",
        "title": "Daily Workout",
        "type": "GENERAL_FITNESS"
      }
    }
  ],
  "pagination": {...}
}

Ejemplo de Cliente Hono

import { hcWithType } from '@vitality-gym/api/client'

const client = hcWithType('http://localhost:3000')

const res = await client.api.v1.gamification.streaks.$get({
  query: {
    isActive: 'true'
  }
})

---

Obtener Racha por ID

Obtener una racha específica con historial.

• URL: /api/v1/gamification/streaks/:id
• Método: GET
• Autenticación Requerida: Sí

---

Obtener Mis Mejores Rachas

Obtener las mejores rachas del usuario.

• URL: /api/v1/gamification/streaks/best
• Método: GET
• Autenticación Requerida: Sí

Respuesta

{
  "data": {
    "currentBest": {
      "type": "WORKOUT_STREAK",
      "currentStreak": 15
    },
    "allTimeBest": {
      "type": "GOAL_STREAK",
      "longestStreak": 45
    },
    "topStreaks": [...]
  }
}

---

Usar Congelación de Racha

Usar una congelación para proteger una racha.

• URL: /api/v1/gamification/streaks/:id/freeze
• Método: POST
• Autenticación Requerida: Sí

Descripción Interna

Este endpoint usa un freeze para proteger una racha:

1. Verifica que el streak tenga freezes disponibles
2. Verifica que la racha esté activa
3. Actualiza freezesUsed++ y freezesAvailable—
4. Marca el día como wasFrozen

Respuesta

{
  "data": {
    "id": "...",
    "freezesUsed": 3,
    "freezesAvailable": 2,
    "message": "Freeze used successfully"
  }
}

---

Añadir Congelaciones de Racha (Admin)

Añadir congelaciones a la racha de un usuario.

• URL: /api/v1/gamification/streaks/:id/add-freezes
• Método: POST
• Autenticación Requerida: Sí (Admin)

Cuerpo de Solicitud

{
  "amount": 3
}

Tipos de Racha

Tipo	Descripción
WORKOUT_STREAK	Entrenamientos consecutivos
GOAL_STREAK	Cumplimiento de objetivos diarios
ATTENDANCE_STREAK	Asistencia al gimnasio
CLASS_STREAK	Asistencia a clases