Referência do SDK

O que a fachada exporta

import {
  createApp, TrivoApp, TrivoClient,          // o ciclo de vida
  TrivoRest,                                  // o cliente REST, se você o montar à mão
  TrivoInteraction,                           // o objeto de uma interação
  TrivoError,                                 // toda recusa do Trivo
  InteractionVerifier, interactionResponse,   // o endpoint HTTP
  BASE_URL_ENV_VAR, TOKEN_ENV_VAR,
  DEFAULT_DEDUPE_MAX_ENTRIES, DEFAULT_TIMESTAMP_TOLERANCE_SECONDS,
} from "@trivo/sdk";

TrivoClient é o mesmo TrivoApp, sob o nome que quem vem de outra plataforma procura primeiro. É um apelido, e não uma segunda classe: duas implementações da mesma coisa seriam a ambiguidade que este SDK evita no resto todo.

O ciclo de vida: createApp e TrivoApp

app.rest, método a método

TrivoInteraction

Os tipos que você vai querer nomear

Estes atravessam as assinaturas públicas, e por isso têm nome na fachada: sem eles, fatorar createRole({ permissions }) numa função sua não teria como tipar o parâmetro, e a saída natural seria any bem no lugar em que o vocabulário é fechado.

import type {
  Permission,               // "gerenciar_canais" | "banir_membros" | …
  ReactionEmoji,            // o emoji de uma reação
  GatewayIntent,            // "messages" | "reactions" | …
  InteractionType,          // "command" | "autocomplete" | …
  CommandOption,            // uma opção da árvore de um comando
  AutocompleteSuggestions,  // o que suggest() aceita
  AppModal,                 // o que showModal() aceita
} from "@trivo/sdk";

function darCargo(nome: string, permissions: readonly Permission[]) {
  return app.rest.createRole({ serverId, name: nome, permissions, revision });
}

Além destes, a fachada exporta as formas de resposta de cada método (o retrato do servidor, a mensagem, o cargo, o comando registrado), TrivoAppOptions, ErrorCode, GatewayStatus, InteractionOutcome, ReplyOptions e os tipos do verificador. Os nomes públicos são em inglês pela mesma régua que faz o evento se chamar message_create.

ReplyOptions é o segundo argumento de interaction.reply e o de interactionResponse.reply — uma definição só, e não um gêmeo por caminho de entrega. É o que permite fatorar function responder(texto: string, opcoes: ReplyOptions) sem cair no any.

TrivoError e o verificador

Toda recusa do Trivo vira TrivoError, com code de vocabulário fechado, status, is(...) para comparar sem escrever a string duas vezes e os extras da recusa: retryAfterSeconds é campo, e currentRevision e resetAt são acessores que leem o corpo — os três valem null ou undefined na recusa que não os traz. O corpo inteiro continua em erro.body, e o catálogo está em Erros.

InteractionVerifier e interactionResponse são o par do endpoint HTTP: verify decide se a entrega é do Trivo, e interactionResponse monta o corpo da resposta. As duas constantes de configuração — DEFAULT_TIMESTAMP_TOLERANCE_SECONDS e DEFAULT_DEDUPE_MAX_ENTRIES — são exportadas porque quem dimensiona o processo precisa dos números sem abrir o nosso código. O mecanismo está em Assinatura das entregas.