Core
@getenginex/sdk é o núcleo do SDK: o cliente (createEnginexClient), a sessão e seus tokens, o tenant, os erros e os fluxos que todo app de player precisa, independentes de produto: conta, configuração do operador, carteira e PIX, KYC, jogo responsável, notificações e realtime. Os pacotes de produto (iGaming e Predictions) e os adapters de framework (Frameworks) são montados sobre ele.
| Namespace | O que faz |
|---|---|
auth | cadastro, login e 2FA e senha |
config | configuração e branding do operador; o widget de suporte |
profile | perfil e sessões do jogador |
wallet, deposits | saldo e extrato; depósito PIX (saldo ao vivo) |
withdrawals | saque com OTP |
pixKeys | chaves PIX do jogador |
kyc | verificação de identidade |
responsibleGambling | jogo responsável |
notifications | notificações |
Instalação
npm i @getenginex/sdk
# or
pnpm add @getenginex/sdkO core não tem peer dependencies. A única dependência é o zod 4 (dependência comum, compartilhada com os pacotes de produto quando as faixas batem; veja uma cópia só do zod).
- Ambientes: browsers com
fetcheAbortController, Node 20+, edge runtimes e Bun, em ESM e CommonJS. crypto.randomUUID: só os métodos que enviamIdempotency-Key(os que movimentam dinheiro, comodeposits.createPix) geram chaves. SemrandomUUID(origem insegura, como HTTP na rede local) o SDK usacrypto.getRandomValues; sem Web Crypto nenhum, esses métodos rejeitam comCONFIGURATION_ERROR.- Gateway: por padrão o SDK chama
/api/v1/...na própria origem da página. Faça o proxy de/apipara o gateway do EngineX (Proxy para o gateway).
Entradas
| Import | O que traz |
|---|---|
@getenginex/sdk | createEnginexClient, token stores, EnginexError/isEnginexError e os namespaces acima |
@getenginex/sdk/realtime | createRealtime e coreTopics (Realtime) |
@getenginex/sdk/query | fábricas de queries e mutations para o TanStack Query v5 (Frameworks) |
@getenginex/sdk/testing | createMockFetch e createMockRealtime (Testes e mocks) |
@getenginex/sdk/extension | o contrato para pacotes do SDK, não para apps (Extensibilidade) |
Cada entrada é um arquivo à parte: um app que não importa /realtime não carrega código de WebSocket, e o /testing nunca chega a um bundle de produção que não o importe.
Crie o cliente
Crie um cliente por app no browser e exporte-o:
// enginex.ts
import { createEnginexClient, localStorageTokenStore } from '@getenginex/sdk'
export const enginex = createEnginexClient({
locale: 'pt-BR',
tokenStore: localStorageTokenStore(),
onSessionExpired: () => location.assign('/login'),
})
const config = await enginex.config.get()No servidor (SSR, scripts, testes), crie um cliente por request, com baseUrl e tenantHost. O passo a passo completo (login, sessão, idioma e descarte) está em Primeiros passos; as opções, em Sessão e tokens e Tenant e domínios.
Produtos e frameworks
Os pacotes de produto recebem o cliente do core e reaproveitam sua sessão, tenant, hooks e validação:
import { createIgaming } from '@getenginex/sdk-igaming'
import { createPredictions } from '@getenginex/sdk-predictions'
export const igaming = createIgaming(enginex)
export const predictions = createPredictions(enginex)Eles declaram o core como peer dependency (>=0.6.0 <1.0.0): instale o core uma vez, no topo do app. Para React, Next.js e Vue, veja Frameworks.
Testes
@getenginex/sdk/testing roda o cliente inteiro sem gateway: createMockFetch() responde às rotas do core com dados que passam nos schemas do SDK, e createMockRealtime() é um WebSocket falso. Veja Testes e mocks.