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

iGaming ​

@getenginex/sdk-igaming traz os fluxos de cassino, bônus, missões, fidelidade, indicações e sportsbook FIRST do EngineX, montados sobre o cliente do core (@getenginex/sdk). O operador instala só o produto que tem: quem não usa cassino não carrega nenhum código de cassino.

NamespaceO que faz
casinocatálogo (jogos, categorias, provedores), abrir jogo, sessões, histórico e ranking de ganhadores
bonuscampanhas de bônus (vitrine, ofertas, opt-in, resgate) e promo codes
missionsmissões ativas do operador (paginadas) e o progresso do jogador
loyaltypontos, tier e benefícios do jogador; resgate de pontos
referralscódigo e link de indicação, histórico (e-mail do indicado mascarado) e registro de código
sportsbooksessão do sportsbook FIRST (URL com token de operador para o iframe)

Instalação ​

bash
npm i @getenginex/sdk @getenginex/sdk-igaming
# or
pnpm add @getenginex/sdk @getenginex/sdk-igaming

O core é peer dependency do pacote de iGaming: o app instala o core uma vez e todos os pacotes de produto usam essa mesma cópia. Os requisitos são os do core (veja Instalação).

  • Versões do core: o @getenginex/sdk-igaming declara o core como peer >=0.6.0 <1.0.0 (a 0.6.0 traz o dinheiro estrito e a idempotência por tentativa que os pacotes usam; a 0.5.0 foi a primeira com o registerProductClient, que liga o iGaming às fábricas do /query; até a 0.3.x do iGaming, >=0.2.0). Esse range orienta o gerenciador de pacotes; a garantia em tempo de execução é o contrato de transporte do core (a versão interna TRANSPORT_CONTRACT_VERSION, gravada junto de cada cliente): se o cliente vier de uma cópia do core com um contrato incompatível (ex.: duas versões do core instaladas), createIgaming lança CONFIGURATION_ERROR na hora, em vez de funcionar pela metade.
  • zod: é dependência comum do core e do iGaming (não peer), deduplicada numa cópia só quando as faixas batem. Com um zod fora da faixa no app (ex.: zod@3), podem ficar duas cópias — o SDK funciona, mas o bundle pesa mais; instale um único zod 4 no topo do projeto (veja Instalação).

Crie o cliente de iGaming ​

Crie o cliente do core como em Primeiros passos e passe-o para createIgaming:

ts
// enginex.ts
import { createEnginexClient, localStorageTokenStore } from '@getenginex/sdk'
import { createIgaming } from '@getenginex/sdk-igaming'

export const enginex = createEnginexClient({
  locale: 'pt-BR',
  tokenStore: localStorageTokenStore(),
})

export const igaming = createIgaming(enginex)

createIgaming não cria sessão, tenant nem transporte próprios e não faz nenhum request. Todo método de iGaming passa pelo cliente do app:

  • a mesma sessão e renovação de tokens (login feito com enginex.auth.login vale para o cassino);
  • o mesmo tenant (X-Original-Host), locale, timeout, hooks e validação;
  • os mesmos erros (isEnginexError(error, code));
  • enginex.dispose() desliga também o iGaming: depois dele, todo método rejeita com CONFIGURATION_ERROR.

Crie um cliente de iGaming por cliente do core: no browser, um por app; no servidor, um por request, junto com o cliente. Um valor que não é um cliente criado por createEnginexClient (por exemplo, uma cópia { ...enginex }) é rejeitado com CONFIGURATION_ERROR.

Queries ​

@getenginex/sdk-igaming/query traz as fábricas de iGaming para o TanStack Query v5, com as convenções da camada de queries: createIgamingQueries(igaming) devolve uma fábrica de query por método de leitura e createIgamingMutations(igaming) uma mutation por método de escrita, com os mesmos nomes e entradas dos namespaces. São objetos simples: o pacote não depende do TanStack.

ts
import { createIgamingMutations, createIgamingQueries } from '@getenginex/sdk-igaming/query'

const ig = createIgamingQueries(igaming)
ig.casino.listGames({ page: 1 }) // { queryKey: ['enginex', 'public', 'casino', 'listGames', { page: 1 }], queryFn }
ig.loyalty.get() // { queryKey: ['enginex', 'user', userId, 'loyalty', 'get'], queryFn }

const im = createIgamingMutations(igaming)
im.loyalty.redeem() // { mutationKey: ['enginex', 'loyalty', 'redeem'], mutationFn, invalidates }
TipoFábricas
leituras públicas (chave ['enginex', 'public', ...], sem login)casino.listGames/listCategories/listProviders/getGame, bonus.listPublicOffers
leituras do jogador (chave ['enginex', 'user', userId, ...])casino.listSessions/getHistory/getBiggestWinners, bonus.listOffers/getOffer/listParticipations/getParticipation, missions.list/listMine, loyalty.get, referrals.get/listHistory
mutationscasino.launchGame, bonus.optIn/claim/redeemPromoCode/resolvePromoCode, loyalty.redeem, referrals.register, sportsbook.createSession
  • bonus.optIn/claim/redeemPromoCode e loyalty.redeem invalidam o próprio namespace e a wallet do core (o saldo); referrals.register invalida referrals; casino.launchGame invalida casino.listSessions.
  • As idempotentes (bonus.optIn/claim/redeemPromoCode, loyalty.redeem) aceitam { idempotencyKey } na fábrica (veja Idempotência).
  • As que carregam credenciais (promo code, URL do jogo, sessão do sportsbook) têm gcTime: 0.
  • Passe o próprio objeto devolvido por createIgaming: uma cópia { ...igaming } lança CONFIGURATION_ERROR.

No React (e no Next.js), useEnginexQueries e useEnginexMutations recebem a fábrica do produto e o cliente de iGaming, e memoizam o resultado:

tsx
import { createIgamingMutations, createIgamingQueries } from '@getenginex/sdk-igaming/query'
import { useEnginexMutation, useEnginexMutations, useEnginexQueries, useEnginexQuery } from '@getenginex/sdk-react'
import { igaming } from './enginex'

function LoyaltyCard() {
  const ig = useEnginexQueries(createIgamingQueries, igaming)
  const im = useEnginexMutations(createIgamingMutations, igaming)
  const loyalty = useEnginexQuery(ig.loyalty.get())
  const redeem = useEnginexMutation(im.loyalty.redeem())
  return (
    <button disabled={redeem.isPending} onClick={() => redeem.mutate({ points: 500, redemptionType: 'bonus' })}>
      Redeem 500 of {loyalty.data?.currentPoints ?? 0} points
    </button>
  )
}

No Vue, o mesmo par vem de @getenginex/sdk-vue; useEnginexQuery recebe um getter:

vue
<script setup lang="ts">
import { createIgamingQueries } from '@getenginex/sdk-igaming/query'
import { useEnginexQueries, useEnginexQuery } from '@getenginex/sdk-vue'
import { igaming } from './enginex'

const ig = useEnginexQueries(createIgamingQueries, igaming)
const games = useEnginexQuery(() => ig.casino.listGames({ page: 1 }), { select: (page) => page.items })
</script>

<template>
  <GameCard v-for="game in games.data.value ?? []" :key="game.id" :game="game" />
</template>

No servidor do Next.js, prefetchEnginex(createIgamingQueries(igaming), (ig) => [ig.casino.listGames()]) faz o prefetch do catálogo com as mesmas chaves (veja Next.js). Svelte, Solid e o TanStack puro usam as fábricas direto (Sem adapter).

Testes ​

@getenginex/sdk-igaming/testing soma as rotas mock de iGaming ao createMockFetch do core (veja Testes e mocks). As rotas do core continuam valendo e as suas (routes) vencem as de iGaming:

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({ withdrawalOtp: true })),
})
const igaming = createIgaming(enginex)

Para montar o objeto de rotas à mão, use createIgamingRoutes(), que devolve rotas novas (com estado próprio) a cada chamada: createMockFetch({ routes: { ...createIgamingRoutes(), ...minhasRotas } }).