Changelog
Notas de cada versão dos pacotes do SDK. A documentação é versionada pela versão do core (@getenginex/sdk); as notas dos pacotes de produto ficam na seção de cada um.
@getenginex/sdk
0.7.0
Minor Changes
8020869: Align the SDK with the gateway contract in production.
Type changes (may need code changes when upgrading):
@getenginex/sdk:PixDeposit.expiresAtis now optional (string | undefined); code such asnew Date(pix.expiresAt)must handle a missing expiry. New optional fields:PixDeposit.redirectUrl,Deposit.expiresAtandDeposit.redirectUrl.@getenginex/sdk-igaming:GameLaunchgains the requiredlaunchTarget(new exported typeLaunchTarget:'iframe' | 'redirect' | 'new_tab'or a future value) and the optionalproviderCodeandexpiresAt. Hand-writtenGameLaunchobjects (e.g. test fixtures) need alaunchTarget.
Behavior changes:
deposits.createPixno longer throwsVALIDATION_ERRORafter the charge was created when the payment provider reports no expiry.- The session is renewed and the request retried only on a 401 that refuses the access token: a 401 without a code (what the gateway's auth middleware answers for a missing, expired or invalid token),
TOKEN_EXPIREDorTOKEN_STALE. A 401 with any other code, such asINVALID_CREDENTIALSfor a wrong current password inchangePasswordordisable2fa, or an explicitUNAUTHENTICATED/TOKEN_INVALID, is no longer retried and no longer firesonAccessTokenRejected. An error body with a top-levelcode(e.g.TOKEN_STALE) now keeps that code. auth.logoutsends the stored refresh token so the gateway revokes it. With an expired access token the gateway refuses the call before revoking, so logout renews once (without storing the new tokens or callingonSessionExpired) and revokes the renewed refresh token. The local session is always cleared; if the renewal or the request fails, the refresh token may stay valid on the server until it expires.casino.launchGamereturnslaunchTarget, so apps can open each game the way its provider requires. A response without it is treated asiframe, as before. The testing mock returnslaunch_target,provider_codeandexpires_at.withdrawals.requestdocs and the testing mock match the gateway: while an OTP request is pending (until itsexpiresAt, also after its code was confirmed), the same request is replayed and any other request is refused withFAILED_PRECONDITION(422)another withdrawal request is pending, instead of replacing it. After a confirmed withdrawal, the next one can only be requested once the previous request expires.
Patch Changes
- 7be12eb: Code comments, TSDoc and runtime error messages are now in English. Error
codevalues are unchanged; if your UI showserror.messageto players, it now shows English text — mapcodeto your own copy instead. - d330035: READMEs and package metadata in English; docs site now in English, Portuguese and Spanish.
0.6.0
Minor Changes
af441d0: Breaking (antes do 1.0).
- Idempotência das mutations: a
Idempotency-Keysó é reaproveitada depois de falha ambígua (NETWORK_ERROR,TIMEOUT, 5xx,KEY_IN_USEeVALIDATION_ERRORdepois de 2xx, em que a operação pode ter acontecido, ainda está em processamento ou já aconteceu), para a mesma entrada (por conteúdo) e no mesmo objeto de opções;isAmbiguousFailureem/extensionaplica essa regra.ABORTEDlibera a chave: quem cancela e quer repetir a mesma operação passaidempotencyKey. Como migrar: "tentar de novo" commutate({ ...mesmos valores })já reaproveita a chave; quem dependia de um objeto constante para uma operação nova não precisa mudar nada; quem precisa repetir depois de recarregar a página passaidempotencyKey. - Dinheiro estrito: valores monetários fora de inteiro seguro, moeda fora de
/^[A-Z]{3}$/e casas decimais fora de 0-8 rejeitam a resposta inteira comVALIDATION_ERRORtambém emvalidation: 'warn'(inclui itens de listas, mapas e uniões, e o saldo do realtime,coreTopics.balance). A listaconfig.currenciessegue como texto livre. Como migrar: nada no app; um gateway fora do contrato passa a aparecer como erro. baseUrlaceita só''ou a origem (https://host[:porta]); qualquer outro valor, inclusive'/', lançaCONFIGURATION_ERRORna criação. O throw é síncrono, dentro decreateEnginexClient: um cliente criado no topo de um módulo derruba o import (inclusive no SSR). Como migrar: tire/apidobaseUrl; o SDK acrescenta/api/v1.randomIdcom fallback emgetRandomValues(origem insegura, como HTTP na LAN, volta a funcionar); sem Web Crypto,CONFIGURATION_ERROR(antes,TypeError).- Novos:
sessionOwner: 'app'(o app grava e renova os tokens; o SDK só lê otokenStore;auth.login/auth.logoute escritas de sessão lançamCONFIGURATION_ERRORantes de enviar;'app'comautoRefresh: trueeonAccessTokenRejectedsem'app'lançam na criação) eonAccessTokenRejected(chamado uma vez por access token recusado com 401, também em chamadasauth: 'optional'; ounauthorizeddo realtime não o dispara; um 401 de um token que o app já trocou notokenStoredurante o request é repetido uma vez com o token atual, sem aviso);enginexKeys.user(userId, namespace, method?)(o layout da chave é contrato);withdrawals.confirmOtp({ otp, requestId })(orequestIddewithdrawals.requestnão vai ao gateway e separa os desafios);createAttempts/mutationCallOf/runMutation/money/moneyText/currencyCode(com{ allowEmpty: true }para moeda que pode vir'')/decimalPlaces/strictValue/randomIdem/extension. perPagecontinua o nome no SDK e vai comolimitno fio nas rotas que o gateway pede assim (documentado emdeposits.listenotifications.list).createMockFetch(muda o comportamento dos testes): o id da chave PIX criada deixa de sermock-pix-key-1, que colidia com a chave semeada; testes que fixavam esse id devem ler o id devolvido.
- Idempotência das mutations: a
0.5.0
Minor Changes
- 4bc271e: Novo entry
@getenginex/sdk/query, agnóstico de framework:createQueries(enginex)ecreateMutations(enginex)devolvem uma fábrica por método de leitura ({ queryKey, queryFn }) e uma mutation por método de escrita ({ mutationKey, mutationFn, invalidates }), com os mesmos nomes e entradas dos namespaces e compatíveis comuseQuery/useMutation/prefetchQuerydo TanStack Query v5, sem depender dele. Chaves['enginex', 'public', namespace, método, input?](dados sem sessão) e['enginex', 'user', userId, namespace, método, input?](dados do jogador, com ouserIdda sessão no momento da chamada; sem sessão,'anonymous'equeryFnrejeitando comUNAUTHENTICATEDsem request, o mesmo quando a sessão muda de usuário antes dofetch);inputsó entra quando informado e nenhuma chave contém token ou senha. OqueryFnrepassa osignaldo contexto aofetch. Sóconfig.*trazstaleTime(5 minutos).invalidates(input, result)lista os prefixos afetados (depósito/saque → carteira e o próprio namespace;pixKeys.*→pixKeys.list;notifications.*→notifications;auth.login/auth.logout→['enginex', 'user']...).enginexKeystraz os prefixos (all,public,user(),user(userId)). Para pacotes do SDK:queryScope(cliente ou produto)(chaves, fábricas de leitura pública/de usuário e mutations) em/queryeregisterProductClient(produto, cliente)em/extension, que liga o objeto de um pacote de produto ao cliente do core. Depósito e saque (createPix,withdrawals.request/confirmOtp) mandam umaIdempotency-Keypor objeto de entrada (o retry do TanStack não duplica a operação): a chave derivada é descartada depois de um sucesso e mantida depois de um erro, inclusive 4xx (tentar de novo com a mesma entrada reusa a chave); também aceitam{ idempotencyKey }na fábrica; as mutations deauth.*(excetologout) ewithdrawals.confirmOtptrazemgcTime: 0.
0.4.0
Minor Changes
5cbe27b: Novo namespace
enginex.kyc(verificação de identidade):getStatus()devolveKycStatus(level:none/basic/intermediate/full;status:not_started/pending/in_review/approved/rejected, uniões abertas sem o prefixo do protobuf;cpfVerified,documentVerified,selfieVerified,addressVerified;rejectionReasoneupdatedAtcomonullquando o gateway manda texto vazio ou a data epoch) euploadDocument({ documentType, file })envia o documento (rg_front,rg_back,cnh_front,cnh_back,passport,selfie,proof_address;fileéBlob/File) como multipart e devolve{ documentId }.documentTypefora da lista oufileque não éBlobrejeitam comCONFIGURATION_ERRORsem request; um 201 sem confirmação (success: falseou id vazio) rejeita comUNKNOWN(status201) e a mensagem do gateway quando vem, senão a do SDK (regra documentada:UNKNOWNcomstatus2xx = operação não confirmada, releia o estado antes de tentar de novo). Nível ou situação desconhecidos chegam crus e vão paraonValidationIssueemvalidation: 'warn'; em'strict',VALIDATION_ERROR.KycLeveleKycStatusValuenomeiamunspecified.O transporte passa a aceitar corpo
FormData(multipart, semContent-TypeJSON: o runtime define o boundary; o mesmoFormDataé reenviado inteiro no retry após um 401 renovado), também para pacotes de produto via@getenginex/sdk/extension. Os hooks de request (onRequest,onResponse,onError) ganhamctx.bodysó nesses requests: um resumo{ kind: 'form-data', fields: [{ name, type?, size? }] }(tiposRequestBodySummary, comkindcomo união aberta, eFormDataFieldSummary), nunca o nome original nem o conteúdo do arquivo, nem o valor dos campos de texto. Corpos JSON continuam iguais e fora dos hooks.@getenginex/sdk/testing:createMockFetch()respondeGET /api/v1/kyc/statuse aceita o upload multipart dePOST /api/v1/kyc/documents(201, ou 400INVALID_ARGUMENTcomo o gateway);MockRequest.bodytraz o próprioFormDataem requests multipart.Novo namespace
enginex.responsibleGambling(jogo responsável):getLimits()devolveResponsibleGamblingLimits(deposit.daily|weekly|monthlycomo{ limit, used },loss.daily,sessionTimeLimitMinuteseselfExclusion: { until, permanent }; limite0e data epoch viramnull);setLimits({ dailyDeposit, weeklyDeposit, monthlyDeposit, dailyLoss, sessionTimeMinutes })envia só os campos presentes (nullenvia0, "remover limite", inferido) e devolve{ updatedAt }(o gateway aplica em 24 h);selfExclude({ duration })(24h,7d,30d,6m,1y,permanent) devolve{ excludedUntil, permanent };getRealityCheck()devolve limite de sessão, depósito do dia e limite de perda. Valor de limite que não é inteiro ≥ 0, input sem campo nenhum edurationfora da lista, ausente ou de outro tipo rejeitam comCONFIGURATION_ERRORsem request. O mock de@getenginex/sdk/testingresponde as quatro rotas. O 429 do limitador global do gateway (corpo fora do envelope) já viraRESOURCE_EXHAUSTEDcomretryAfterem segundos; agora há teste de regressão. Nova página "Erros de compliance" nos docs.Novo namespace
enginex.notifications:list({ page?, perPage?, unreadOnly? })devolvePage<Notification> & { unreadCount }(enviapage,limiteunread=truesó comunreadOnly; como o gateway manda sótotaleunread_count, o SDK monta oPage:totalPages0 sem notificações,ceil(total / perPage)nas demais eitems: []para página além do fim; em'warn', umtotalque não é inteiro ≥ 0 vale 0, nuncaNaN);Notificationé{ id, type, title, message, read, createdAt }comtypeem minúsculas sem o prefixo do protobuf (bet_won,kyc_approved,unspecified..., união aberta; desconhecido chega cru e vai paraonValidationIssueem'warn') ecreatedAtnullpara a data epoch;markAsRead({ notificationId })resolvevoid;getPreferences()eupdatePreferences({ email?, sms?, push?, marketing? })trabalham com{ email, sms, push, marketing }(oPUTenvia só os campos presentes e devolve o corpo da resposta, semmessage).perPagefora de 1–100 ou não inteiro,pageinválido,unreadOnlynão booleano,notificationIdvazio e preferências sem campo ou não booleanas rejeitam comCONFIGURATION_ERRORsem request. O mock de@getenginex/sdk/testingresponde as quatro rotas. Novas páginas "Notificações" (REST × realtime) e "Suporte (widget)" nos docs.
0.3.0
Minor Changes
b5f1178: Novo entry
@getenginex/sdk/realtime:createRealtime(enginex)devolve o realtime do cliente (sempre a mesma instância; o parâmetro é tipado comoEnginexClient, então o objeto de um pacote de produto não compila), com uma conexão WebSocket aberta no primeirosubscribee fechada ~1 s após o últimooff(); reconexão com backoff exponencial e jitter (1 s → 30 s, sem limite de tentativas), ping JSON a cada 30 s (sem resposta em 10 s, reconecta), reinscrição de todos os tópicos eonResyncdepois de cada reconexão (onResync(listener)para todos os tópicos, recebendo o tópico completo, ouonResync(topic, listener)para um só, com o mesmo descritor dosubscribe); token em?token=renovado antes de conectar, reconexão quando o usuário da sessão muda (tópicos privados do usuário anterior são descartados) e uma única renovação + reconexão quando o gateway respondeunauthorizednum tópico privado (se repetir, statusclosedpara todos os tópicos eUNAUTHENTICATEDnoonError; se a própria renovação falhar, a tentativa não é gasta e o backoff cresce até 30 s); outroserrordo gateway numsubscribe(ex.:rate_limited) vão aoonError(RESOURCE_EXHAUSTED) e osubscribeé reenviado com backoff; modo sequenciado (snapshot/delta/heartbeat, com detecção de gap,snapshot_requeste, após 10 s sem snapshot,onResynccom o próximo delta como nova base); mensagens validadas no modo do cliente. SemWebSocketdisponível (runtime antigo; o Node 22+ tem o global),subscribeé no-op e o status fica'unavailable'. Novas opções do cliente:wsUrlewebSocket(tiposWebSocketLike/WebSocketLikeInstance, sem depender dalib: DOM). Fora do browser o gateway exige o headerOrigin: passe emwebSocketum construtor que o acrescente (oWebSocketdo Node ou o pacotewsdireto não bastam); o realtime assina oerrordo socket, então um erro de conexão dowsnão derruba o processo.@getenginex/sdk/extensionganhadefineTopic(e os tiposTopic,TopicDefinition,WireSchema) para os pacotes de produto definirem os próprios tópicos. Para apps, o descritorTopicé opaco:Topic.definitioné detalhe interno. O contrato interno do registro de clientes passa à versão 2: pacotes de produto que embutam uma cópia antiga do core recebemCONFIGURATION_ERROR.Novos tópicos do core:
coreTopics.balance()(BalanceUpdate:available,change,changeType,description?,updatedAt, semreserved/bonus/total, que o gateway não preenche) ecoreTopics.notification()(RealtimeNotification;typeé uma união aberta:info,success,warning,errorou outro valor que o gateway enviar, então trate o caso padrão). O snapshot do modo sequenciado debalance:(protobuf cru deGetBalance) não é entregue;TopicDefinitionganhasnapshots?: 'deliver' | 'ignore'para isso.@getenginex/sdk/testingganhacreateMockRealtime(options?):WebSocketfalso comemit,emitSequenced,drop,rejectPrivate/acceptPrivate,connectionsesent, para testar o realtime sem gateway. Para orejectPrivate(), é privado o tópico que termina nosubdo token da conexão (ou o que a opçãoisPrivatedisser).
0.2.0
Minor Changes
- ffc0bd1: Carteira e PIX no core: novos namespaces
wallet(get,getBalance,listTransactionspaginado comcategory),deposits(createPix,get,list),withdrawals(request,confirmOtp,get,list,cancel) epixKeys(add,list,remove,setDefault), todos com login obrigatório e valores em unidades menores.deposits.createPix,withdrawals.requestewithdrawals.confirmOtpsão idempotentes (Idempotency-Keygerada ou deoptions.idempotencyKey, reusada no retry após 401) e validam a resposta sempre em modo estrito.withdrawals.requestdevolve a união{ status: 'otp_required', requestId, expiresAt } | { status: 'created', withdrawal };confirmOtp({ otp })confirma o pedido pendente da própria sessão. Status de depósito/saque chegam normalizados (DEPOSIT_STATUS_COMPLETED→'completed'). Novos códigos de erro do middleware de idempotência emGATEWAY_ERROR_CODES:KEY_IN_USE,PAYLOAD_MISMATCHeINVALID_KEY. OcreateMockFetchde@getenginex/sdk/testingganha rotas padrão com estado em memória para carteira, depósito, saque (opçãowithdrawalOtp) e chaves PIX (201 nas rotas de criação, como o gateway), rotas com parâmetro (:nome, valores no novo campo opcionalreq.params) e um terceiro argumento opcionalstatusemok(data, meta?, status?). - a043c79: Novo entry
@getenginex/sdk/extension: contrato estável para pacotes de produto do SDK (@getenginex/sdk-igaming,@getenginex/sdk-predictions).getExtensionTransport(client)dá acesso ao transporte do próprio cliente (sessão, refresh, tenant, hooks, validação edispose()), com umExtensionRequestSpecpúblico (auth,idempotent,validation: 'strict',options), além dos helpers de schemawire,mapOfelazy. Os exports do entry principal não mudam. - d4ebcf2: Novos tipos públicos
CursorPage<T>({ items, nextCursor? }) eCursorPageInput({ cursor?, pageSize? }) para listagens paginadas por cursor, ao lado dePage, exportados pelo entry principal e reexportados por@getenginex/sdk/extension(usados pelas campanhas de bônus do@getenginex/sdk-igaming). Só tipos: nenhum export de runtime muda. - cbf1a39: Helpers de dinheiro no entry principal:
formatMoney(amountMinor, currency, locale?),toMinorUnits(value, currency)efromMinorUnits(amountMinor, currency), com as casas decimais deconfig.currencye sem erro de ponto flutuante (toMinorUnitslê o texto decimal dígito a dígito e rejeita negativos). NovoCallOptions.idempotencyKey: métodos idempotentes (movimentação de dinheiro) a enviam no headerIdempotency-Keye a reusam no retry após um 401; nos demais é ignorada. Também vale paraidempotent: trueno entry@getenginex/sdk/extension. - 826a4d8:
@getenginex/sdk/testingganhamarkDepositPaid(mockFetch, depositId): simula o banco confirmando um PIX no estado docreateMockFetch(o depósito viracompletede o saldo sobe o valor dele, uma única vez). - 126ff24: Novo namespace
profileno cliente:profile.get()(GET /me),profile.update({ username?, displayName? })(PUT /me),profile.listSessions()(GET /me/sessions) eprofile.revokeSession({ sessionId })(DELETE /me/sessions/{id}), todos com login obrigatório. Novos tiposProfile,ProfileSession,UpdateProfileInputeProfileApi. OcreateMockFetchde@getenginex/sdk/testingganha rotas padrão para/mee/me/sessions. - eb3921a: Ids
./..num segmento do caminho (ex.:deposits.get({ depositId: '..' })), que a URL normalizaria para outra rota, agora rejeitam comINVALID_ARGUMENT(status: 0) antes de qualquerfetch— inclusive nos requests de pacotes de produto via@getenginex/sdk/extension. Orawentregue aonValidationIssuepassa a mascarar também as chavesip,device,user_agent/userAgent(nome exato) e as terminadas em_url/Url. - 7144ada: Modo
validation: 'warn'agora recupera por campo: um campo fora do formato chega como veio (em camelCase) e o resto da resposta continua convertido (listas desembrulhadas, enums normalizados, dinheiro emnumber, padrões preenchidos,nextCursornormalizado), inclusive nos schemas de pacotes de produto feitos comwire/mapOfde@getenginex/sdk/extension. Antes, qualquer divergência entregava a resposta inteira só em camelCase, sem nenhuma conversão.onValidationIssuerecebe os caminhos completos dos campos. Mudança de comportamento: se a própria raiz da resposta não tem o formato esperado (ex.: texto no lugar de objeto), o modo'warn'passa a lançarVALIDATION_ERROR. O modo'strict'não muda.
0.1.0
Minor Changes
A 0.1.0 nunca foi publicada no npm: todo o conteúdo abaixo sai na 0.2.0, a primeira versão publicada do SDK TypeScript para os fluxos de player do EngineX.
Escopo
createEnginexClient: um cliente por app (browser) ou por request (servidor).config:get,getBranding,getProducts,getSportsbookegetSupport.auth:register;logincom 2FA ({ status: '2fa_required' }e nova chamada comtwoFactorCode);forgotPassword/resetPassword;verifyEmail/resendVerificationEmail;verifyPhone/resendPhoneVerification;lookupCpf;saveLead;logout;changePassword;requestPhoneChange/confirmPhoneChange;enable2fa/verify2fa/disable2fa.session:get()esubscribe().- Onde guardar os tokens:
memoryTokenStore(padrão) elocalStorageTokenStore, com a interface públicaStorageLike(a opçãostoragedolocalStorageTokenStore, sem depender delib: DOM);TokenStorepara stores próprios. - Tenant: o
X-Original-Hosté resolvido automaticamente — no browser, só em chamadas same-origin (tenantHost ?? location.host); fora do browser, a partir detenantHost(combaseUrlabsoluto).
Assinatura uniforme
- Todo método público segue
(input?, options?). Métodos sem parâmetros usamNoParamse aceitamundefinedno primeiro argumento (ex.:logout(undefined, { signal })). CallOptions = { signal, fetchOptions }em todo método.- O código do 2FA se chama
twoFactorCodeemlogin,verify2faedisable2fa.
Configuração e SSR
createEnginexClientnunca lança por configuração ausente:baseUrl,tenantHostefetchsó são resolvidos no primeiro request. Se faltar algo, esse request rejeita comCONFIGURATION_ERRORsem chamarfetch— seguro para singletons importados durante o SSR (Next.js, Nuxt).
Sessão
session.get()devolve um snapshot congelado e estável: a mesma referência enquanto a sessão não muda, pronto parauseSyncExternalStore.Sessiontem camposreadonly.- Refresh proativo (antes de expirar) e reativo (após um 401), single-flight (requests concorrentes compartilham um único refresh) e entre abas (o
localStorageTokenStorereusa tokens renovados por outra aba). onSessionExpiredé chamado só quando o refresh é recusado pelo gateway (400/401/403): a sessão é limpa e o request original rejeita com o 401 (rotas com sessão opcional repetem sem token). Falha de rede no refresh mantém os tokens.
Opções e métodos do cliente
autoRefresh(padrãotrue): comfalse, nenhum refresh é feito — para clientes de servidor.hooks:onRequest/onResponsea cada tentativa eonErroruma vez por chamada pública que falhar. Nunca recebem headers, tokens, corpo nem query string; o refresh interno da sessão é invisível para eles.fetchOptionspor chamada (ex.:next,cache,credentials):method,bodyesignalsão sempre os do SDK, e os headers reservados (authorization,x-original-host,idempotency-key,content-type,accept,accept-language) são removidos antes de o SDK aplicar os seus.client.setLocale()troca oAccept-Languagedos próximos requests.client.dispose()solta a assinatura notokenStore; depois dele, todo método rejeita comCONFIGURATION_ERROResession.subscribevira no-op. Idempotente; não cancela nada em voo.
Erros
EnginexErrorcomtoString(),toJSON()eEnginexError.from(), que nunca lança e produz uma mensagem limitada que não vaza o conteúdo de objetos arbitrários; tipoEnginexErrorJSON.ErrorDetailsMap, extensível por declaration merging, comCaptchaRequiredDetails(captcha_required→CaptchaRequiredDetails | undefined: leia come.details?.site_key).isEnginexError(e, code)estreitacodeedetails.GATEWAY_ERROR_CODESeSDK_ERROR_CODESlistam todos os códigos conhecidos.
Validação de respostas
- Modo
'warn'por padrão: semonValidationIssue, avisa comconsole.warnuma vez por rota, só com a rota e os caminhos dos campos. ValidationIssue.rawvem mascarado: credenciais (token,password,secret,backup_codes) e dados pessoais (cpf,email,phone,name,birth_date/birthDate) viram'[REDACTED]'.- Rotas que devolvem tokens ou segredos (
login, refresh da sessão,enable2fa) são sempre validadas em modo estrito.
Dependências e tamanho
- Única dependência:
zod(viazod/mini), com schemas preguiçosos e tree-shakeable: ~12,8 kB (brotli) importando o cliente, ~0,5 kB importando sóisEnginexError/EnginexError. - O SDK não altera a configuração global nem o locale do Zod do app.
Testes: @getenginex/sdk/testing
createMockFetchcom respostas padrão realistas (config, cadastro, login com e sem 2FA, refresh, logout), os helpersokefaile os tiposMockHandler,MockRequesteMockFetchOptions.- Em Node, o cliente ainda precisa de
baseUrlabsoluto etenantHost(valores fictícios servem).
Compatibilidade
engines.node >= 20; ESM e CJS; tipos que compilam semlib: DOM, emmoduleResolutionnode16ebundler.- Browsers, Node, Edge (Vercel Edge, Cloudflare Workers) e Bun.
- Licença Apache-2.0.
Política de versões
- Enquanto estiver em
0.x, versões minor (0.x.0) podem trazer mudanças incompatíveis; versões patch (0.x.y) não. As interfaces devolvidas pelo SDK não foram feitas para o app implementar — excetoTokenStoreeStorageLike—, então ganhar campos ou métodos novos não é quebra.
Para quem usou uma pré-versão
code2fa→twoFactorCode.config.*(options)→config.*(undefined, options).logout(options)→logout(undefined, options).- A referência da API mudou de endereço: agora fica em
/referencia/api/@getenginex/sdk/....
@getenginex/sdk-igaming
0.6.0
Minor Changes
8020869: Align the SDK with the gateway contract in production.
Type changes (may need code changes when upgrading):
@getenginex/sdk:PixDeposit.expiresAtis now optional (string | undefined); code such asnew Date(pix.expiresAt)must handle a missing expiry. New optional fields:PixDeposit.redirectUrl,Deposit.expiresAtandDeposit.redirectUrl.@getenginex/sdk-igaming:GameLaunchgains the requiredlaunchTarget(new exported typeLaunchTarget:'iframe' | 'redirect' | 'new_tab'or a future value) and the optionalproviderCodeandexpiresAt. Hand-writtenGameLaunchobjects (e.g. test fixtures) need alaunchTarget.
Behavior changes:
deposits.createPixno longer throwsVALIDATION_ERRORafter the charge was created when the payment provider reports no expiry.- The session is renewed and the request retried only on a 401 that refuses the access token: a 401 without a code (what the gateway's auth middleware answers for a missing, expired or invalid token),
TOKEN_EXPIREDorTOKEN_STALE. A 401 with any other code, such asINVALID_CREDENTIALSfor a wrong current password inchangePasswordordisable2fa, or an explicitUNAUTHENTICATED/TOKEN_INVALID, is no longer retried and no longer firesonAccessTokenRejected. An error body with a top-levelcode(e.g.TOKEN_STALE) now keeps that code. auth.logoutsends the stored refresh token so the gateway revokes it. With an expired access token the gateway refuses the call before revoking, so logout renews once (without storing the new tokens or callingonSessionExpired) and revokes the renewed refresh token. The local session is always cleared; if the renewal or the request fails, the refresh token may stay valid on the server until it expires.casino.launchGamereturnslaunchTarget, so apps can open each game the way its provider requires. A response without it is treated asiframe, as before. The testing mock returnslaunch_target,provider_codeandexpires_at.withdrawals.requestdocs and the testing mock match the gateway: while an OTP request is pending (until itsexpiresAt, also after its code was confirmed), the same request is replayed and any other request is refused withFAILED_PRECONDITION(422)another withdrawal request is pending, instead of replacing it. After a confirmed withdrawal, the next one can only be requested once the previous request expires.
Patch Changes
- 7be12eb: Code comments, TSDoc and runtime error messages are now in English. Error
codevalues are unchanged; if your UI showserror.messageto players, it now shows English text — mapcodeto your own copy instead. - d330035: READMEs and package metadata in English; docs site now in English, Portuguese and Spanish.
0.5.0
Minor Changes
af441d0: Breaking (antes do 1.0). Exige
@getenginex/sdk >=0.6.0 <1.0.0.- Dinheiro estrito nas respostas: valores monetários (inteiro seguro, em número ou texto), moeda (
/^[A-Z]{3}$/) e casas decimais (0-8) inválidos rejeitam a resposta inteira comVALIDATION_ERROR, também emvalidation: 'warn'(campanhas de bônus, totais do cassino, resgate de fidelidade e indicações). Como migrar: nada no app; um gateway fora do contrato passa a aparecer como erro. - Indicações (
referrals): um valor monetário inválido agora rejeita a lista inteira (antes, o item era descartado em silêncio). Como migrar: trate o erro da listagem; não há mais itens sumindo. - Decisão registrada (desvio do rascunho, que exigia moeda sempre preenchida): a moeda vazia (
'') é aceita só nos valores de campanha do bônus e nocurrencydo resgate de fidelidade, porque o gateway omite a moeda no protojson quando o valor é 0; aceitar o vazio evita derrubar a listagem de campanhas. Em qualquer outro campo, moeda vazia rejeita a resposta. Pontos de fidelidade e progresso de missões não são dinheiro. - Idempotência: as mutations (
bonus.optIn/claim/redeemPromoCode,loyalty.redeem) reaproveitam aIdempotency-Keysó depois de falha ambígua, para a mesma entrada e na mesma mutation;ABORTEDlibera a chave. Como migrar: "tentar de novo" commutate({ ...mesmos valores })já reaproveita a chave; para repetir depois de recarregar a página, passeidempotencyKey.
- Dinheiro estrito nas respostas: valores monetários (inteiro seguro, em número ou texto), moeda (
0.4.0
Minor Changes
- ddc9d2c: Novo entry
@getenginex/sdk-igaming/query:createIgamingQueries(igaming)ecreateIgamingMutations(igaming)devolvem uma fábrica por método de leitura ({ queryKey, queryFn }) e uma mutation por método de escrita ({ mutationKey, mutationFn, invalidates }), com os mesmos nomes e entradas dos namespaces (casino,bonus,missions,loyalty,referrals,sportsbook) e as mesmas convenções de chave do@getenginex/sdk/query, compatíveis comuseQuery/useMutation/prefetchQuerydo TanStack Query v5 sem depender dele. Catálogo do cassino e ofertas públicas de bônus usam chavepublic; o resto das leituras usa a chave do usuário (userIdda sessão,'anonymous'eUNAUTHENTICATEDsem request quando não há sessão).bonus.optIn/claim/redeemPromoCodeeloyalty.redeemmandam umaIdempotency-Keypor objeto de entrada (o retry não duplica a operação) e aceitam{ idempotencyKey }na fábrica;loyalty.redeemebonus.optIn/claim/redeemPromoCodeinvalidam o namespace e o saldo do core (wallet),referrals.registerinvalidareferralsecasino.launchGamecasino.listSessions.bonus.resolvePromoCode,bonus.redeemPromoCode,casino.launchGameesportsbook.createSessiontrazemgcTime: 0(código promocional, URL do jogo e token do sportsbook).createIgamingpassa a registrar o objeto do produto no cliente do core (registerProductClient, do core 0.5.0), por isso o peer@getenginex/sdksobe de>=0.2.0 <1.0.0para>=0.5.0 <1.0.0.
0.3.0
Minor Changes
bfd181d: Novo namespace
igaming.missions(missões):list({ page?, perPage? })devolvePage<Mission>(enviapageelimit; oPagesai dometado envelope do gateway) elistMine()devolveUserMission[](o progresso do jogador, lido dedata.missions).Missioné{ id, name, description, missionType, objectiveType, targetValue, targetGameCategory, targetGames, rewardType, rewardValue, validFrom, validTo };UserMissioné{ id, missionId, missionName, currentProgress, targetValue, progressPercentage, status, rewardType, rewardValue, periodEnd, completedAt }.targetGamesnulo vira[]; categoria vazia, data epoch (1970-01-01T00:00:00Z) eperiod_end/completed_atausentes viramnull;targetValue/rewardValuesão inteiros eprogressPercentageé número.missionType(daily,weekly,event,permanent),objectiveType(wager,bet_count,win_amount,play_game,deposit),rewardType(bonus,free_spins,points,free_bet) estatus(in_progress,completed,expired,claimed) são uniões abertas em minúsculas: valor desconhecido chega cru e vai paraonValidationIssueemvalidation: 'warn'; em'strict',VALIDATION_ERROR.pageque não é inteiro ≥ 1 eperPagefora de 1–100 rejeitam comCONFIGURATION_ERRORsem request. Os dois métodos exigem login. Não háclaim()(o gateway não tem rota de resgate).withIgamingRoutes(@getenginex/sdk-igaming/testing) responde as duas rotas. Nova página "Missões" nos docs. O peer do core continua>=0.2.0 <1.0.0.Novo namespace
igaming.loyalty(fidelidade):get()devolveLoyaltyStatus(totalPointsEarned,currentPoints,pointsRedeemed,currentTier,tierPoints,lifetimeWagered,lifetimeDeposited,tierBenefits,tierExpiresAt) eredeem({ points, redemptionType })devolve{ redeemedPoints, value, currency, bonusId }.tierBenefitsé otier_benefits_jsonjá convertido em objeto: texto vazio ou ausente viranullsem aviso; JSON inválido ou que não é um objeto viranulle vai paraonValidationIssue(sem o texto no issue; em'strict',VALIDATION_ERROR).tierExpiresAt,value,currency,bonusIdecurrentTiervazios ou ausentes viramnull.redemptionTypeé uma união aberta (bonus,cash,free_bet);pointsnão inteiro ou ≤ 0 eredemptionTypevazio rejeitam comCONFIGURATION_ERRORsem request.redeemmandaIdempotency-Key(gerada, ou a deoptions.idempotencyKey, mantida no retry após 401), mas o gateway ainda não aplica o middleware de idempotência nesta rota: trave o botão, um duplo clique pode resgatar duas vezes. Um 200 sem confirmação (successdiferente detrue) rejeita comUNKNOWN(status200) e a mensagem do gateway quando vem, senão a do SDK: releiaget()antes de tentar de novo.withIgamingRoutesrespondeGET /loyaltyePOST /loyalty/redeem. Nova página "Fidelidade" nos docs. O peer do core continua>=0.2.0 <1.0.0.Novo namespace
igaming.referrals(indicações):get()devolveReferralInfo(code,link,totalReferrals,completedReferrals,pendingReferrals,totalEarned,bonusPerReferral,minDeposit);listHistory({ page?, perPage? })devolvePage<Referral>maiscompletedCountetotalEarned(o gateway manda a paginação dentro dodata: o SDK monta oPage, calculatotalPagese não deixatotalItemsficar abaixo dos itens já vistos);register({ code })devolve{ id, code, status, refereeBonus, createdAt }(HTTP 201). O gateway escreve o dinheiro como float na unidade maior; o SDK converte para unidades menores comMath.round(valor * 100), metades para longe do zero (19.99→1999,0.1 + 0.2→30,1e-7→0, negativos mantêm o sinal), e valor não finito rejeita comVALIDATION_ERRORemstrict.ReferraltrazrefereeNameerefereeEmailMasked(ana@exemplo.com→a**@exemplo.com; vazio ou inválido viranull); o e-mail cru e oreferee_idnunca são expostos (nem no resultado, nem nos issues, nem nos erros), também emvalidation: 'warn'quando um item falha inteiro e o core devolve a lista crua: o SDK refaz cada indicação (máscara, status, dinheiro em unidades menores) e descarta o que não é objeto ou cujo dinheiro não vira unidades menores. Umtotal_itemsfora do formato em'warn'vale 0 (nuncaNaN).status(pending,qualified,completed,expired) é uma união aberta;completedAt,expiresAtecreatedAtausentes ou epoch viramnull.pageeperPageinválidos ecodevazio rejeitam comCONFIGURATION_ERRORsem request. Quem está se cadastrando usaauth.register({ referralCode })do core.withIgamingRoutesresponde as três rotas. Nova página "Indicações" nos docs. O peer do core continua>=0.2.0 <1.0.0.
0.2.0
Minor Changes
f91eacb: Novo namespace
igaming.sportsbookcomcreateSession(params?, options?)(GET /first/session, exige login): devolve{ launchUrl, expiresInSeconds, expiresAt }para abrir o sportsbook FIRST num iframe.expiresAt(ms) é calculado no cliente (relógio na resposta +expiresInSeconds * 1000); ooperator_tokennão entra no tipo público.launchUrlcarrega o token de operador: a resposta é sempre validada em modo estrito (launch_urlhttp(s) absoluta eexpires_in_seconds> 0, senãoVALIDATION_ERROR) e nenhum hook nemonValidationIssuea recebe.createIgamingRoutes/withIgamingRoutesganham a rota mock de/first/session. Sem cache no SDK: reutilize a sessão atéexpiresAt - 30 se chequeenginex.config.getSportsbook()antes.Novo entry opcional
@getenginex/sdk-igaming/first-framecomconnectFirstFrame(iframe, handlers, options?): ponte tipada para os eventospostMessagedo iframe do FIRST (onReady,onBetPlaced,onInsufficientFunds,onDepositClick,onLoginRequired,onHeightChange,onRedirect,onScrollToTopeonEventgenérico) esend(eventType, eventData)para comandos. EmonRedirect,linksó chega se for texto (umlinkde outro tipo é descartado). Só entrega mensagens comevent.source === iframe.contentWindoweevent.originigual à origem dosrc;sendposta sempre para essa origem (nunca'*'). Não importa o core em runtime nem exigelib.dom(FirstFrameTarget/FirstFrameWindowsão estruturais); os erros de configuração sãoCONFIGURATION_ERRORreconhecidos porisEnginexError. Fora do entry principal: quem importa sócreateIgamingnão o leva no bundle.
0.1.0
Minor Changes
- 7be46cc: Namespace
bonusemcreateIgaming(enginex):listPublicOffers(vitrine pública, sem mandar a sessão),listOffers,getOffer,listParticipationsegetParticipation(paginação por cursor:CursorPage/CursorPageInputdo core),optIn,claimeredeemPromoCode(idempotentes: mandamIdempotency-Key, a do chamador emoptions.idempotencyKeyou uma gerada, reusada no retry após 401; respostas validadas sempre em modo estrito) eresolvePromoCode. As campanhas chegam do formato protojson do gateway em camelCase, com enums sem prefixo e em minúsculas, dinheiro emnumber(unidades menores), durações em segundos e o estado da participação emstatus(+qualifiedAt,completedAt,expiredAt)./testingganha as rotas mock de bônus (três campanhas, promo codeBEMVINDO, opt-in/claim/resgate com estado e replay porIdempotency-Key). - 6397a2f: Namespace
casinoemcreateIgaming(enginex):listGames(filtros por categoria, provedor, busca,idse ordenação, paginado),listCategories,listProvidersegetGame(públicos, sem mandar a sessão),launchGame(exige login; devolvesessionIdegameUrl, com o idioma vindo dolocaledo cliente viaAccept-Language),listSessions,getHistory(paginados) egetBiggestWinners. A URL do jogo carrega o token da sessão de jogo: volta só no resultado — nunca nos hooks nem noonValidationIssue— e a resposta do launch é validada sempre em modo estrito. Valores do histórico e do ranking (int64 em texto no fio) chegam comonumberem unidades menores./testingganha as rotas mock do cassino (catálogo fixo, launch com URL fictícia e sessões em memória). - eb5d851: Novo pacote
@getenginex/sdk-igaming:createIgaming(enginex)monta os namespaces de iGaming sobre o cliente de@getenginex/sdk(peer dependency), sem sessão, tenant nem transporte próprios — tudo passa pelo contrato@getenginex/sdk/extensiondo core. Um valor que não é um cliente criado porcreateEnginexClienté rejeitado comCONFIGURATION_ERROR.@getenginex/sdk-igaming/testingtrazcreateIgamingRoutes()ewithIgamingRoutes(options)para somar as rotas mock de iGaming aocreateMockFetchdo core. Cassino e bônus chegam nas próximas versões. - eb3921a: O core é declarado como peer
@getenginex/sdk@>=0.2.0 <1.0.0(a primeira versão com o entry@getenginex/sdk/extension); em tempo de execução, um cliente de uma cópia do core com contrato de transporte incompatível fazcreateIgaminglançarCONFIGURATION_ERROR.
Patch Changes
- Updated dependencies [ffc0bd1]
- Updated dependencies [a043c79]
- Updated dependencies [d4ebcf2]
- Updated dependencies [cbf1a39]
- Updated dependencies [826a4d8]
- Updated dependencies [126ff24]
- Updated dependencies [eb3921a]
- Updated dependencies [7144ada]
- @getenginex/sdk@0.2.0
@getenginex/sdk-next
0.2.1
Patch Changes
- 7be12eb: Code comments, TSDoc and runtime error messages are now in English. Error
codevalues are unchanged; if your UI showserror.messageto players, it now shows English text — mapcodeto your own copy instead. - d330035: READMEs and package metadata in English; docs site now in English, Portuguese and Spanish.
- Updated dependencies [7be12eb]
- Updated dependencies [d330035]
- @getenginex/sdk-react@0.2.1
0.2.0
Minor Changes
- af441d0: Acompanha o
@getenginex/sdk-react(versão fixa em conjunto): reexportauseUserKeye a tentativa de idempotência por instância douseEnginexMutation. Exige@getenginex/sdk >=0.6.0 <1.0.0. Como migrar: nada além de atualizar o core junto; veja as notas do@getenginex/sdk-react.
Patch Changes
- Updated dependencies [af441d0]
- @getenginex/sdk-react@0.2.0
0.1.0
Minor Changes
97610c6: Novo pacote
@getenginex/sdk-next, adapter do Next.js (App Router). O entry principal reexporta tudo de@getenginex/sdk-react(dependência do pacote, então o app instala só osdk-next). O entry@getenginex/sdk-next/server(server-only) trazgetEnginexServer(options?): um client do core por request, memoizado com ocache()do React (na mesma request, opções iguais devolvem o mesmo client; requests diferentes nunca compartilham client), com o tenant tirado deheaders()na ordemhost→x-forwarded-host(x-original-hostsó comtrustOriginalHost: true, quando oproxy.tsdo app o sobrescreve em toda request;resolveHosttroca tudo), o gateway debaseUrlou da variável de ambienteENGINEX_GATEWAY_URL, anônimo por padrão (não lê cookies,autoRefresh: false) enext: { revalidate, tags }repassado a todofetch. Sem gateway absoluto ou sem tenant, rejeita comCONFIGURATION_ERRORantes de qualquerfetch. Peers:next >=15,react >=19,@tanstack/react-query ^5e@getenginex/sdk >=0.5.0 <1.0.0. Sai sempre com a mesma versão do@getenginex/sdk-react(grupofixeddos changesets).@getenginex/sdk-next/servertraz tambémprefetchEnginex(source, select): prefetch das fábricas do core (com o client do servidor) ou de um pacote de produto (createIgamingQueries(igaming)) numQueryClientnovo por chamada, sem retry, devolvendo odehydratepara oHydrationBoundary; uma fábrica que falha não derruba as outras e fica fora do estado (só queries com sucesso são desidratadas). OstaleTimenão viaja no estado: a nova busca no browser depende dostaleTimedoQueryClientdo browser (o que oEnginexProvidercria usa 60 s). EreadCookieTokenStore({ name }), que lê no servidor (só leitura,cookies()do Next) a sessão gravada pelonextCookieTokenStore({ name, maxAge, path }), o novoTokenStoreem cookie do entry principal (SameSite=Lax; Secure; Path=/, semHttpOnly: o refresh e o?token=do WebSocket precisam do token em JavaScript; fora do browser não guarda nada; um cookie que o browser recusa, sem HTTPS ou acima de ~4 KB, gera umconsole.warn;name,pathemaxAgeinválidos lançamCONFIGURATION_ERROR). O padrão continua olocalStorage. Novo entry@getenginex/sdk-next/configcomwithEnginex(nextConfig, { gatewayUrl, paths }), que acrescenta o rewrite/api/:path*→ gateway preservando os rewrites do app (array ou{ beforeFiles, afterFiles, fallback }), sem duplicar umsourceque o app já reescreve sem condição (has/missing) e compondo com outros wrappers (config em objeto ou função).
Patch Changes
- Updated dependencies [96d4be2]
- @getenginex/sdk-react@0.1.0
@getenginex/sdk-predictions
0.3.1
Patch Changes
- 7be12eb: Code comments, TSDoc and runtime error messages are now in English. Error
codevalues are unchanged; if your UI showserror.messageto players, it now shows English text — mapcodeto your own copy instead. - d330035: READMEs and package metadata in English; docs site now in English, Portuguese and Spanish.
0.3.0
Minor Changes
af441d0: Breaking (antes do 1.0). Exige
@getenginex/sdk >=0.6.0 <1.0.0.- Dinheiro estrito nas ordens (colateral, taxas e custo), nas posições e no resumo do portfólio: valor monetário fora de inteiro seguro e moeda fora de
/^[A-Z]{3}$/rejeitam a resposta inteira comVALIDATION_ERROR, também emvalidation: 'warn'. Decisão registrada (desvio do rascunho): a moeda vazia ('') é aceita só emsettlement_currency. Preços, quantidades e taxas em bps não são dinheiro e seguem a validação comum;volume_24h,total_volume,min_order_sizeemax_positionficam fora da checagem estrita por decisão (agregados e limites do mercado, em centavos).settlement_currencyausente no mercado vira''(não rejeita). No realtime,maker_fee/taker_feedo tópico de trades passam pela mesma checagem: valor monetário inválido descarta a mensagem (como ocoreTopics.balance). Como migrar: nada no app; um gateway fora do contrato passa a aparecer como erro. orders.placeBatchpor tentativa: as chaves de cada ordem ficam por resultado decreatePredictionsMutations(no React, memoizado poruseEnginexMutations), são reaproveitadas depois de falha ambígua (inclusiveKEY_IN_USEeVALIDATION_ERRORdepois de 2xx) ou sucesso parcial enquanto o conteúdo do lote for o mesmo, e viram novas depois de sucesso total, erro não ambíguo ou lote diferente. Cada envio fecha só a própria tentativa: um lote que termina depois de outro ter começado não descarta as chaves do outro. Como migrar: tire o registro de chaves por objeto; para repetir depois de recarregar a página, passeidempotencyKeyem cada ordem.- Sem Web Crypto, gerar a
idempotencyKeyrejeita comCONFIGURATION_ERROR(antes,UNKNOWN). Como migrar: troque a checagem porUNKNOWNporCONFIGURATION_ERROR; em HTTP na LAN o SDK usagetRandomValuese segue funcionando.
- Dinheiro estrito nas ordens (colateral, taxas e custo), nas posições e no resumo do portfólio: valor monetário fora de inteiro seguro e moeda fora de
0.2.0
Minor Changes
- ddc9d2c: Novo entry
@getenginex/sdk-predictions/query:createPredictionsQueries(predictions)ecreatePredictionsMutations(predictions)devolvem uma fábrica por método de leitura ({ queryKey, queryFn }) e uma mutation por método de escrita ({ mutationKey, mutationFn, invalidates }), com os mesmos nomes e entradas dos namespaces (markets,comments,orders,portfolio) e as mesmas convenções de chave do@getenginex/sdk/query, compatíveis comuseQuery/useMutation/prefetchQuerydo TanStack Query v5 sem depender dele.markets.*ecomments.listusam chavepublic;comments.listMine,orders.*eportfolio.*usam a chave do usuário (userIdda sessão,'anonymous'eUNAUTHENTICATEDsem request quando não há sessão).orders.place/placeBatch/cancel/amendinvalidamorders,portfolioe o saldo do core (wallet);comments.create/like/unlikeinvalidamcomments.listecomments.listMine.orders.placemanda umaIdempotency-Keypor objeto de entrada (o retry não duplica a ordem) e aceita{ idempotencyKey };orders.placeBatchgera umaidempotencyKeypor ordem do lote, reusada até todas as ordens do lote darem certo; sucesso parcial mantém as chaves (reenviar o mesmo lote não duplica as ordens que já entraram).createPredictionspassa a registrar o objeto do produto no cliente do core (registerProductClient, do core 0.5.0), por isso o peer@getenginex/sdksobe de>=0.3.0 <1.0.0para>=0.5.0 <1.0.0.
0.1.0
Minor Changes
- 6b14e55: Novo pacote
@getenginex/sdk-predictions(peer@getenginex/sdk >=0.3.0 <1.0.0):createPredictions(enginex)cria os namespaces de predictions sobre o cliente do core, com a mesma sessão, tenant, hooks, validação edispose()(valida o cliente na criação,CONFIGURATION_ERRORpara um valor que não é um cliente do core, e não faz nenhum request). Traz os namespacesmarkets(categorias, eventos, mercados, orderbook e histórico de preços, listas como arrays) ecomments(listar, comentar, curtir e listar os próprios,{ items, total }), com enums em minúsculas e sem o prefixo do protobuf. Traz tambémorders(colocar uma ordem idempotente: a mesma chave no headerIdempotency-Keye emidempotency_key, reusada no retry após 401; lote não atômico com uma chave por ordem; listar, buscar, cancelar e alterar) eportfolio(posições, posição por mercado e resumo;PositionTrade.directionéOrderDirection, normalizada como os demais enums), com ids validados antes do request (vazio, com espaço no início ou no fim, com/,.ou..rejeitam comCONFIGURATION_ERROR; o SDK não apara ids), preço inteiro (1 a 99 na limitada; opcional na a mercado, que manda 0) e quantidade inteira validados antes do request, eidempotencyKeyopcional por ordem no lote. O entry@getenginex/sdk-predictions/realtimetrazpredictionsTopics(orderbook,trades,marketeorders, este privado) para orealtime.subscribedo core, com enums em minúsculas (aceitayeseORDER_SIDE_YESno fio); o snapshot sequenciado detradesnão é entregue (tem outro formato). O entry@getenginex/sdk-predictions/testingtrazcreatePredictionsRoutes()ewithPredictionsRoutes()(com o catálogo, os comentários, as ordens e o portfólio mock) para somar aocreateMockFetchdo core.
@getenginex/sdk-react
0.2.1
Patch Changes
- 7be12eb: Code comments, TSDoc and runtime error messages are now in English. Error
codevalues are unchanged; if your UI showserror.messageto players, it now shows English text — mapcodeto your own copy instead. - d330035: READMEs and package metadata in English; docs site now in English, Portuguese and Spanish.
0.2.0
Minor Changes
af441d0: Breaking (antes do 1.0). Exige
@getenginex/sdk >=0.6.0 <1.0.0.useEnginexMutationguarda a tentativa de idempotência (entrada eIdempotency-Key) por instância do hook: ela sobrevive a re-render e aoretrydo TanStack mesmo com opções novas a cada render, e a chave só é reaproveitada depois de falha ambígua (NETWORK_ERROR,TIMEOUT, 5xx,KEY_IN_USE,VALIDATION_ERRORdepois de 2xx) para a mesma entrada (por conteúdo). Duas instâncias nunca compartilham chave, e a mesma instância que troca de método (mutationKey) também não. Ajustes (retry,onSuccess...) vão no segundo argumento: espalhar as opções perde a tentativa por instância. Como migrar: "tentar de novo" commutate({ ...mesmos valores })já reaproveita a chave, então dá para tirar chaves e objetos guardados à mão; quem precisa repetir depois de recarregar a página passaidempotencyKeyna fábrica.orders.placeBatch(Predictions): a tentativa do lote fica por resultado decreatePredictionsMutations, memoizado poruseEnginexMutations.- Novo:
useUserKey(namespace?, method?)devolve o prefixo['enginex', 'user', userId, namespace?, method?]da sessão atual para invalidar ou ler do cache (nullsem sessão).
0.1.0
Minor Changes
- 96d4be2: Novo pacote
@getenginex/sdk-react:EnginexProviderliga o client do core e o TanStack Query à árvore React (usa oqueryClientdo app ou cria um por instância, comstaleTimede 60 s nas queries e nunca um singleton de módulo),useEnginex()devolve o client euseSession()acompanha login e logout comuseSyncExternalStore(anônimo no servidor e na hidratação). Ao mudar o usuário da sessão (logout ou outrosub), o provider remove do cache tudo sob['enginex', 'user'], mantendo['enginex', 'public']e as chaves do app. Bundle com'use client'. Peers:react >=18,@tanstack/react-query ^5e@getenginex/sdk >=0.5.0 <1.0.0. HooksuseEnginexQueries()(fábricas do core, ou(factory, product)para as de produto, memoizadas por client/produto),useEnginexQuery(options, overrides?),useEnginexMutations()euseEnginexMutation(options, overrides?): erro tipado comoEnginexError, cancelamento ao desmontar, retry que não repeteUNAUTHENTICATED(os outros erros seguem oQueryClientdo app) e invalidação deinvalidates(input, result)no sucesso, aguardada antes doonSuccessdo app e antes de omutateAsyncresolver.EnginexProviderganhainitialSession(sessão do servidor e da hidratação, para SSR autenticado com cookie, na parte da tela que depende só da sessão; queries de usuário em Client Components renderizam só depois da hidratação, condicionadas aouseSession()). Hooks de realtime:useRealtime(topic, handler)assina ao montar e cancela ao desmontar (uma assinatura só no StrictMode, handler mais recente sem reassinar, tópico comparado pela chave,nullnão assina, tópico privado só com usuário e reassinado na troca de usuário),useRealtimeStatus()euseRealtimeSync()(opt-in: invalida o saldo do usuário embalance_updatesemsetQueryData, as queriesnotificationsem cada notificação e as querieswalletenotificationsnoonResync; tópicos de produto entram emtopics: [{ topic, invalidate }], com as chaves que cada um alimenta).
@getenginex/sdk-vue
0.1.1
Patch Changes
- 7be12eb: Code comments, TSDoc and runtime error messages are now in English. Error
codevalues are unchanged; if your UI showserror.messageto players, it now shows English text — mapcodeto your own copy instead. - d330035: READMEs and package metadata in English; docs site now in English, Portuguese and Spanish.
0.1.0
Minor Changes
- 1cbfe03: Novo pacote: plugin
EnginexPlugine composables Vue (useSession,useUserKey,useEnginexQuery,useEnginexMutation, realtime) sobre@tanstack/vue-queryv5. Queries e mutations recebem um getter das opções.