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

Configuración y branding ​

El namespace config lee lo que el operador configuró: moneda, límites y medios de pago (config.get), identidad visual (config.getBranding), productos habilitados (config.getProducts) y el sportsbook (config.getSportsbook). Todos los métodos son públicos: no requieren inicio de sesión, envían el token solo cuando hay sesión y responden según el tenant del request (consulta Tenant y dominios). El widget de soporte, también en config, tiene su propia página: Soporte (widget).

MétodoRutaDevuelve
config.get()GET /configOperatorConfig: moneda, límites, medios de pago, captcha, OTP, idiomas
config.getBranding()GET /config/brandingBranding: nombre, colores, logos, enlaces legales, contacto, PWA
config.getProducts()GET /config/productsProductsConfig: productos con ruta, orden y estado
config.getSportsbook()GET /config/sportsbookSportsbookConfig: proveedor y configuración de FIRST

Configuración del operador: config.get ​

ts
import { formatMoney } from '@getenginex/sdk'

const config = await enginex.config.get()

config.currency // { code: 'BRL', symbol: 'R$', name: 'Real brasileiro', decimalPlaces: 2 }
config.languages // ['pt-BR']
config.features.casino // true when the casino is turned on

const pix = config.paymentMethods.find((method) => method.code === 'pix')
if (pix?.supportsDeposit) {
  console.log(`Minimum deposit: ${formatMoney(pix.minDeposit, config.currency, 'pt-BR')}`)
}
  • Dinero en centavos (unidades menores). limits y los montos de paymentMethods son enteros en unidades menores (1000 es 10,00 BRL con decimalPlaces: 2). Dales formato con formatMoney y la currency del operador (consulta Dinero).
  • limits: minBet/maxBet llegan siempre; los límites y las comisiones de depósito y retiro solo llegan cuando el gateway identificó al operador.
  • captcha: si el registro exige captcha, el proveedor y su siteKey pública (consulta Registro).
  • otp: enabled y los flows que piden un código (p. ej., register, withdraw_money).
  • timezone y defaultLanguage son opcionales: úsalos para mostrar fechas y elegir el primer idioma.

Un dominio que no pertenece a ningún operador rechaza con INVALID_ARGUMENT. Un monto o una moneda fuera del formato rechaza con VALIDATION_ERROR, incluso con validation: 'warn' (consulta Validación de respuestas).

Branding: config.getBranding ​

ts
const branding = await enginex.config.getBranding()

document.title = branding.operatorName
const root = document.documentElement
for (const [name, value] of Object.entries(branding.colors)) {
  // Colors the operator did not configure come as an empty string: keep the app's default.
  if (value !== '') root.style.setProperty(`--brand-${name}`, value)
}

const logo = document.querySelector<HTMLImageElement>('#logo')
if (logo) logo.src = branding.logos.logoFullDark
CampoQué contiene
operatorId, operatorCode, operatorName, companyNamequién es el operador (nombre visible y razón social)
colorsla paleta completa (primaryColor, backgroundColor, lightPrimaryColor, gradientCta...); un color no configurado llega como ''
logoslogoFullLight (para fondo claro) y logoFullDark (para fondo oscuro)
legalopcional: termsUrl, privacyUrl, responsibleGamblingUrl, cookiePolicyUrl y licenses
contactopcional: supportEmail, supportPhone y socialLinks (nombre → URL)
pwaopcional: appName, appShortName y appDescription para el manifest
integrationsopcional: gtmId y los ids de Storyblok

Toda clave de color existe en BrandingColors, así que branding.colors.primaryColor está tipado sin encadenamiento opcional; comprueba '' antes de usar un valor. legal, contact, pwa e integrations pueden faltar: léelos con ?..

Productos: config.getProducts ​

ts
const { products } = await enginex.config.getProducts()

const menu = products
  .filter((product) => product.status === 'active')
  .sort((a, b) => a.displayOrder - b.displayOrder)
  .map((product) => ({ label: product.productName, href: product.routePath, icon: product.icon }))

Cada Product tiene productType (p. ej., casino, sportsbook, predictions), routePath, displayOrder, status y enabledFeatures, además de mapas libres (settings, limits en centavos, integrationSettings, featureConfig) cuyas claves define el operador. operatorId y operatorCode faltan cuando el gateway no identificó el tenant. Usa getProducts para armar el menú y las rutas; config.get().features solo indica qué productos están activos.

Sportsbook: config.getSportsbook ​

ts
const sportsbook = await enginex.config.getSportsbook()

if (sportsbook.enabled && sportsbook.provider === 'first' && sportsbook.config) {
  const { sportsbookUrl, language, currency, liveBettingEnabled } = sportsbook.config
  console.log(sportsbookUrl, language, currency, liveBettingEnabled)
}

config (la configuración de FIRST: siteId, sportsbookUrl, widgetUrl, language, currency, liveBettingEnabled, cashoutEnabled) solo llega para el proveedor FIRST. Montar el marco y crear la sesión del jugador le corresponde a iGaming: consulta Sportsbook (FIRST).

Caché ​

La configuración cambia poco. Léela una vez por app (o por request en el servidor) y guárdala:

  • Con TanStack Query, las fábricas config.* de @getenginex/sdk/query traen un staleTime de 5 minutos y una clave pública, compartida por todos los usuarios (consulta Frameworks).
  • En Next.js, haz el prefetch en el layout con prefetchEnginex(enginex, (q) => [q.config.get(), q.config.getBranding()]), o guarda la llamada en caché con fetchOptions: { next: { revalidate: 300 } } (consulta Next.js y Extensibilidad).
ts
import { createQueries } from '@getenginex/sdk/query'

const q = createQueries(enginex)
q.config.getBranding() // { queryKey: ['enginex', 'public', 'config', 'getBranding'], queryFn, staleTime: 300_000 }

Pruebas ​

createMockFetch() responde las cuatro rutas con un operador mock (BRL, PIX, un producto de casino y FIRST activo). Sobrescribe una ruta para probar otro operador:

ts
import { createEnginexClient } from '@getenginex/sdk'
import { createMockFetch, ok } from '@getenginex/sdk/testing'

const enginex = createEnginexClient({
  baseUrl: 'https://gateway.test',
  tenantHost: 'casino.test',
  fetch: createMockFetch({
    routes: { 'GET /api/v1/config/products': () => ok({ products: [] }) },
  }),
})

const { products } = await enginex.config.getProducts() // []

Consulta Pruebas y mocks.