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

Core ​

@getenginex/sdk es el núcleo del SDK: el cliente (createEnginexClient), la sesión y sus tokens, el tenant, los errores y los flujos que toda app de player necesita, independientes del producto: cuenta, configuración del operador, billetera y PIX, KYC, juego responsable, notificaciones y realtime. Los paquetes de producto (iGaming y Predictions) y los adapters de framework (Frameworks) se construyen sobre él.

NamespaceQué hace
authregistro, inicio de sesión y 2FA y contraseña
configconfiguración y branding del operador; el widget de soporte
profileperfil y sesiones del jugador
wallet, depositssaldo y extracto; depósito PIX (saldo en vivo)
withdrawalsretiro con OTP
pixKeysclaves PIX del jugador
kycverificación de identidad
responsibleGamblingjuego responsable
notificationsnotificaciones

Instalación ​

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

El core no tiene peer dependencies. Su única dependencia es zod 4 (una dependencia común, compartida con los paquetes de producto cuando los rangos coinciden; consulta una sola copia de zod).

  • Entornos: navegadores con fetch y AbortController, Node 20+, edge runtimes y Bun, en ESM y CommonJS.
  • crypto.randomUUID: solo los métodos que envían Idempotency-Key (los que mueven dinero, como deposits.createPix) generan claves. Sin randomUUID (un origen inseguro, como HTTP en la red local) el SDK usa crypto.getRandomValues; sin Web Crypto, esos métodos rechazan con CONFIGURATION_ERROR.
  • Gateway: por defecto el SDK llama a /api/v1/... en el mismo origen de la página. Haz el proxy de /api al gateway de EngineX (Proxy al gateway).

Entradas ​

ImportQué incluye
@getenginex/sdkcreateEnginexClient, token stores, EnginexError/isEnginexError y los namespaces de arriba
@getenginex/sdk/realtimecreateRealtime y coreTopics (Realtime)
@getenginex/sdk/queryfábricas de queries y mutations para TanStack Query v5 (Frameworks)
@getenginex/sdk/testingcreateMockFetch y createMockRealtime (Pruebas y mocks)
@getenginex/sdk/extensionel contrato para paquetes del SDK, no para apps (Extensibilidad)

Cada entrada es un archivo aparte: una app que no importa /realtime no carga código de WebSocket, y /testing nunca llega a un bundle de producción que no lo importe.

Crear el cliente ​

Crea un cliente por app en el navegador y expórtalo:

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()

En el servidor (SSR, scripts, pruebas), crea un cliente por request, con baseUrl y tenantHost. El paso a paso completo (inicio de sesión, sesión, idioma y liberación) está en Primeros pasos; las opciones, en Sesión y tokens y Tenant y dominios.

Productos y frameworks ​

Los paquetes de producto reciben el cliente del core y reutilizan su sesión, tenant, hooks y validación:

ts
import { createIgaming } from '@getenginex/sdk-igaming'
import { createPredictions } from '@getenginex/sdk-predictions'

export const igaming = createIgaming(enginex)
export const predictions = createPredictions(enginex)

Declaran el core como peer dependency (>=0.6.0 <1.0.0): instala el core una sola vez, en la raíz de la app. Para React, Next.js y Vue, consulta Frameworks.

Pruebas ​

@getenginex/sdk/testing ejecuta todo el cliente sin gateway: createMockFetch() responde las rutas del core con datos que pasan los schemas del SDK, y createMockRealtime() es un WebSocket falso. Consulta Pruebas y mocks.