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

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.

NamespaceO que faz
authcadastro, login e 2FA e senha
configconfiguração e branding do operador; o widget de suporte
profileperfil e sessões do jogador
wallet, depositssaldo e extrato; depósito PIX (saldo ao vivo)
withdrawalssaque com OTP
pixKeyschaves PIX do jogador
kycverificação de identidade
responsibleGamblingjogo responsável
notificationsnotificações

Instalação ​

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

O 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 fetch e AbortController, Node 20+, edge runtimes e Bun, em ESM e CommonJS.
  • crypto.randomUUID: só os métodos que enviam Idempotency-Key (os que movimentam dinheiro, como deposits.createPix) geram chaves. Sem randomUUID (origem insegura, como HTTP na rede local) o SDK usa crypto.getRandomValues; sem Web Crypto nenhum, esses métodos rejeitam com CONFIGURATION_ERROR.
  • Gateway: por padrão o SDK chama /api/v1/... na própria origem da página. Faça o proxy de /api para o gateway do EngineX (Proxy para o gateway).

Entradas ​

ImportO que traz
@getenginex/sdkcreateEnginexClient, token stores, EnginexError/isEnginexError e os namespaces acima
@getenginex/sdk/realtimecreateRealtime e coreTopics (Realtime)
@getenginex/sdk/queryfábricas de queries e mutations para o TanStack Query v5 (Frameworks)
@getenginex/sdk/testingcreateMockFetch e createMockRealtime (Testes e mocks)
@getenginex/sdk/extensiono 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:

ts
// 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:

ts
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.