Esta versión (v0.7) todavía no se publicó en npm.
Ir al contenido

Misiones ​

El progreso de las misiones aparece en la demo de Fidelización (escenario Missions).

El namespace missions de @getenginex/sdk-igaming lista las misiones activas del operador y el progreso del jugador en ellas. Los dos métodos exigen inicio de sesión. En pruebas, withIgamingRoutes ya responde las dos rutas (consulta Pruebas).

Lista y progreso ​

ts
// The operator's active missions (paginated, like the casino catalog).
const page = await igaming.missions.list({ page: 1, perPage: 20 })
page.items.forEach((m) => console.log(m.name, m.missionType, m.targetValue, m.validTo))

// The player's progress (not paginated).
const mine = await igaming.missions.listMine()
for (const m of mine) {
  console.log(m.missionName, `${m.progressPercentage}%`, m.status, m.completedAt)
}

list devuelve Page<Mission> (items, page, perPage, totalItems, totalPages; consulta Paginación): el gateway envía la paginación en el meta del envelope y el SDK la transmite. page es un entero ≥ 1 y perPage un entero de 1 a 100; un valor fuera de eso se rechaza con CONFIGURATION_ERROR, sin request.

  • Mission (la regla): id, name, description, missionType, objectiveType, targetValue, targetGameCategory, targetGames, rewardType, rewardValue, validFrom, validTo. targetGames es [] cuando no hay restricción de juegos; targetGameCategory, validFrom y validTo son null cuando el gateway envía vacío o la fecha epoch (1970-01-01T00:00:00Z).
  • UserMission (el progreso): id, missionId, missionName, currentProgress, targetValue, progressPercentage (número, p. ej.: 37.5), status, rewardType, rewardValue, periodEnd y completedAt (null cuando están ausentes). Para unirla con la regla, relaciona missionId con Mission.id.

Tipos y estados ​

missionType, objectiveType, rewardType y status son uniones abiertas en minúsculas (| (string & {})): el backend las trata como texto libre, así que maneja siempre el caso por defecto.

CampoValores conocidos
missionTypedaily, weekly, event, permanent
objectiveTypewager, bet_count, win_amount, play_game, deposit
rewardTypebonus, free_spins, points, free_bet
status (UserMission)in_progress, completed, expired, claimed

Un valor que el SDK aún no conoce, con validation: 'warn', llega crudo en el campo y va a onValidationIssue; en 'strict' la llamada se rechaza con VALIDATION_ERROR (consulta Validación).

Unidades de targetValue y rewardValue ​

Ambos son enteros. El contrato del servicio de bonos (bonus.proto) no indica la unidad: sus comentarios solo listan los valores de tipo. Las tablas de abajo son una suposición, no confirmada; valida con el operador antes de mostrar valores al jugador.

objectiveTypeUnidad supuesta de targetValue y currentProgress
wager, win_amount, depositunidades menores de la moneda (p. ej., centavos; usa formatMoney del core)
bet_countnúmero de apuestas
play_gamenúmero de rondas en los juegos de targetGames / targetGameCategory
rewardTypeUnidad supuesta de rewardValue
bonus, free_betunidades menores de la moneda
free_spinscantidad de giros
pointspuntos de fidelización

Recompensa y actualización ​

No hay método de canje (claim): la recompensa de una misión completada la acredita el servicio de bonos, sin acción del jugador (inferido: el gateway no expone ninguna ruta de canje). status: 'claimed' es un valor que el servicio puede devolver, pero su significado no está confirmado por el contrato (que solo lista el valor); no dependas de él para decidir si la recompensa fue entregada.

No hay realtime para misiones. Para mostrar el progreso actualizado, consulta listMine() de nuevo después de eventos que lo afectan, como una apuesta o un depósito completado (por ejemplo, al recibir el saldo nuevo por Saldo en vivo), en lugar de hacer polling constante.

Errores ​

CódigoCuándo
UNAUTHENTICATED (401)sin sesión
CONFIGURATION_ERRORpage/perPage fuera de rango (sin request) o cliente ya descartado
VALIDATION_ERRORsolo en validation: 'strict': valor de tipo o estado que el SDK no conoce

Lo que el gateway aún no ofrece ​

  • Ruta de canje: no existe; por eso el SDK no tiene claim().
  • Filtro por tipo: el servicio acepta mission_type_filter, pero el gateway no lo transmite. Filtra en la app por missionType (la lista trae solo misiones activas).
  • Progreso en tiempo real: ningún tópico de realtime; consulta de nuevo.
  • Misiones del jugador paginables: listMine devuelve todo de una vez (solo las activas).

Pruebas ​

ts
import { createEnginexClient } from '@getenginex/sdk'
import { createMockFetch } from '@getenginex/sdk/testing'
import { createIgaming } from '@getenginex/sdk-igaming'
import { withIgamingRoutes } from '@getenginex/sdk-igaming/testing'

const enginex = createEnginexClient({
  baseUrl: 'https://gateway.test', // in Node: absolute baseUrl + tenantHost (optional in the browser)
  tenantHost: 'casino.test',
  fetch: createMockFetch(withIgamingRoutes()),
})
const igaming = createIgaming(enginex)
await enginex.auth.login({ email: 'ana@exemplo.com', password: 'Senha@123' })

const { items, totalItems } = await igaming.missions.list({ perPage: 3 }) // 3 of 4 missions
const mine = await igaming.missions.listMine() // one in progress and one completed

El mock devuelve cuatro misiones fijas, con los formatos del gateway (target_games nulo, fechas epoch, paginación en el meta), y el progreso de dos de ellas.