Skip to main content

Visão geral

Adaptadores permitem que o handler de webhooks do pagamentos.dev funcione com diferentes frameworks web (Hono, Express, Fastify, etc.). Cada adaptador converte o handler genérico (request: Request) => Promise<Response> para o formato esperado pelo framework.

Quando criar um adaptador?

Crie um adaptador quando:
  • O framework não tiver um adaptador oficial ainda
  • Você quiser publicar um adaptador para a comunidade
  • Precisar de comportamento customizado (ex: validação extra, logging)

Estrutura

Como funciona

O handler de webhooks do pagamentos.dev tem uma assinatura universal:
Ele recebe um objeto Request padrão do JavaScript (Web API) e retorna uma Response. Um adaptador simplesmente conecta essa assinatura ao sistema de request/response do framework alvo.

Exemplo: adaptador para Hono

O adaptador oficial do Hono é um dos mais simples possíveis:
Uso:

Exemplo: adaptador para Express

O adaptador do Express precisa extrair o body e as headers da requisição para montar um objeto Request compatível:
Uso:

Publicando um adaptador

  1. Crie um pacote npm com o nome pagamentos-adapter-nome
  2. Declare pagamentos como peerDependency
  1. Exporte uma única função com nome descritivo (ex: toExpress, toFastify)
  2. Documente o uso com exemplos

Adaptadores existentes

Consulte os adaptadores oficiais como referência: