Esta versão (v0.7) ainda não foi publicada no npm.
Pular para o conteúdo

Missões ​

O progresso das missões aparece na demo de Fidelidade (cenário Missions).

O namespace missions de @getenginex/sdk-igaming lista as missões ativas do operador e o progresso do jogador nelas. Os dois métodos exigem login. Em testes, withIgamingRoutes já responde às duas rotas (veja Testes).

Lista e progresso ​

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 devolve Page<Mission> (items, page, perPage, totalItems, totalPages; veja Paginação): o gateway manda a paginação no meta do envelope e o SDK a repassa. page é um inteiro ≥ 1 e perPage um inteiro de 1 a 100; valor fora disso rejeita com CONFIGURATION_ERROR, sem request.

  • Mission (a regra): id, name, description, missionType, objectiveType, targetValue, targetGameCategory, targetGames, rewardType, rewardValue, validFrom, validTo. targetGames é [] quando não há restrição de jogos; targetGameCategory, validFrom e validTo são null quando o gateway manda vazio ou a data epoch (1970-01-01T00:00:00Z).
  • UserMission (o progresso): id, missionId, missionName, currentProgress, targetValue, progressPercentage (número, ex.: 37.5), status, rewardType, rewardValue, periodEnd e completedAt (null quando ausentes). Para juntar com a regra, case missionId com Mission.id.

Tipos e status ​

missionType, objectiveType, rewardType e status são uniões abertas em minúsculas (| (string & {})): o backend trata como texto livre, então trate sempre o caso padrão.

CampoValores conhecidos
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

Um valor que o SDK ainda não conhece, com validation: 'warn', chega cru no campo e vai para onValidationIssue; em 'strict' a chamada rejeita com VALIDATION_ERROR (veja Validação).

Unidades de targetValue e rewardValue ​

Ambos são inteiros. O contrato do serviço de bônus (bonus.proto) não informa a unidade: os comentários dele só listam os valores de tipo. As tabelas abaixo são uma suposição, não confirmada; valide com o operador antes de exibir valores ao jogador.

objectiveTypeUnidade presumida de targetValue e currentProgress
wager, win_amount, depositunidades menores da moeda (ex.: centavos; use formatMoney do core)
bet_countnúmero de apostas
play_gamenúmero de rodadas nos jogos de targetGames / targetGameCategory
rewardTypeUnidade presumida de rewardValue
bonus, free_betunidades menores da moeda
free_spinsquantidade de giros
pointspontos de fidelidade

Recompensa e atualização ​

Não há método de resgate (claim): a recompensa de missão concluída é creditada pelo serviço de bônus, sem ação do jogador (inferido: o gateway não expõe nenhuma rota de resgate). status: 'claimed' é um valor que o serviço pode devolver, mas o significado não é confirmado pelo contrato (que só lista o valor); não dependa dele para decidir se a recompensa foi entregue.

Não há realtime para missões. Para mostrar o progresso atualizado, consulte listMine() de novo depois de eventos que mexem nele, como uma aposta ou um depósito concluído (por exemplo, ao receber o saldo novo por Saldo ao vivo), em vez de fazer polling constante.

Erros ​

CódigoQuando
UNAUTHENTICATED (401)sem sessão
CONFIGURATION_ERRORpage/perPage fora da faixa (sem request) ou cliente já descartado
VALIDATION_ERRORsó em validation: 'strict': valor de tipo ou status que o SDK não conhece

O que o gateway ainda não oferece ​

  • Rota de resgate: não existe; por isso o SDK não tem claim().
  • Filtro por tipo: o serviço aceita mission_type_filter, mas o gateway não o repassa. Filtre no app por missionType (a lista traz só missões ativas).
  • Progresso em tempo real: nenhum tópico de realtime; consulte de novo.
  • Missões do jogador pagináveis: listMine devolve tudo de uma vez (só as ativas).

Testes ​

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

O mock devolve quatro missões fixas, com os formatos do gateway (target_games nulo, datas epoch, paginação no meta), e o progresso de duas delas.