waconector

Conector universal para APIs não-oficiais de WhatsApp. Um contrato único, um adapter por provider — trocar de API vira trocar duas linhas de configuração.

Universal connector for unofficial WhatsApp APIs: one contract, one adapter per provider.

Status: v1.0 — API pública estável. Core de contratos, conector, eventos canônicos, MockAdapter e suite de contrato prontos; 9 adapters (WAHA, Evolution GO, uazapi, Z-API, Wuzapi, Whapi, QuePasa, WPPConnect, izapia) implementados e verificados, passando 100% da suite de contrato compartilhada. Mudanças que quebram compatibilidade agora exigem um bump major (semver de verdade), não mais "aceitáveis em minors" como na fase 0.x.

O problema

uazapi, WAHA, Evolution GO, Wuzapi, Whapi, Z-API, WPPConnect, QuePasa, izapia... todas fazem as mesmas operações — conectar instância, enviar texto/mídia, receber mensagens via webhook — mas cada uma com auth, endpoints, payloads e eventos diferentes. Integrar com uma é fácil; ficar refém dela, também.

A solução

import { createConnector } from 'waconector';
import { waha } from 'waconector/waha';
// ou: import { evolution } from 'waconector/evolution';
// ou, para testar sem provider real: import { MockAdapter } from 'waconector/testing';

const adapter = waha({ baseUrl: 'http://localhost:3000', apiKey: process.env.WAHA_API_KEY! });
const wa = createConnector(adapter);

// Instância: conectar e ler QR
const { qr } = await wa.instance.connect();
adapter.simulateConnected();

// Enviar (aceita E.164 com pontuação ou JID; o waconector normaliza)
await wa.messages.sendText({ to: '+55 (85) 99999-9999', text: 'Olá!' });

// Receber: webhooks de qualquer provider viram eventos canônicos
wa.on('message.received', async (event) => {
  console.log(`${event.message.chatId}: ${event.message.text}`);
});

// Em qualquer framework (Express, Fastify, Next.js, Workers):
// app.post('/webhook', (req, res) => {
//   wa.webhooks.dispatch({ headers: req.headers, body: req.body });
//   res.sendStatus(200);
// });
await wa.webhooks.dispatch(adapter.buildIncomingText('5585988887777', 'oi'));

Princípios de design

• Normalizar o comum, preservar o específico — todo objeto normalizado carrega raw com o payload original do provider.
• Capabilities declaradas — cada adapter anuncia o que suporta; chamar fora do conjunto lança UnsupportedCapabilityError. Consulte com wa.supports('messages.sendMedia').
• Webhooks que nunca derrubam seu endpoint — wa.webhooks.parse não lança: payload desconhecido vira evento unknown (com raw para você inspecionar).
• Erros tipados — WaConnectorError com code (AUTH_FAILED, RATE_LIMITED, INSTANCE_DISCONNECTED...), provider e causa original. Cheque com isWaConnectorError(err).
• Zero dependências de runtime — fetch nativo, Node ≥ 20, ESM + CJS.

Testando seu bot sem provider real

waconector/testing publica o MockAdapter — instância simulada, outbox de envios e webhooks sintéticos (buildIncomingText, buildAck, buildConnectionUpdate). Seu bot inteiro é testável em memória. Use simulateConnected() para pular direto ao estado connected, ou simulateState(state) para forçar qualquer outro estado do ciclo de vida (ex.: 'qr').

Exemplos

Bots mínimos e executáveis em examples/, usando MockAdapter por padrão — zero credenciais reais:

• examples/express — webhook + envio via Express: npm install && npm start.
• examples/nextjs — webhook via API route do Next.js (App Router): npm install && npm run dev.

Cada exemplo tem seu próprio README.md com instruções para trocar o MockAdapter por um provider real via variáveis WACONECTOR_* (o mesmo esquema usado por npx waconector doctor, abaixo).

CLI: npx waconector doctor

Diagnóstico de conectividade/auth contra um provider real, configurado via variáveis de ambiente:

WACONECTOR_BASE_URL=http://localhost:3000 WACONECTOR_API_KEY=sua-chave \
  npx waconector doctor --provider waha

--provider (ou -p) escolhe o adapter (waha, evolution, uazapi, zapi, wuzapi, whapi, quepasa, wppconnect, izapia); as demais opções vêm de variáveis WACONECTOR_* específicas do provider — rode sem elas definidas para ver exatamente quais são exigidas. doctor só chama instance.status() (checagem de leitura) — nunca connect(), então é seguro rodar quantas vezes quiser sem alterar o estado da instância no provider. Sai com código 0 em caso de sucesso, 1 em qualquer falha (útil em scripts/CI).

Providers

Provider	Status		Provider	Status
WAHA	✅ F1		Whapi	✅ F3
Evolution GO	✅ F1		WPPConnect	✅ F3
uazapi	✅ F2		QuePasa	✅ F3
Wuzapi	✅ F2		izapia	✅ F1+
Z-API	✅ F2

Roadmap completo e arquitetura em docs/CONTEXT.md; decisões registradas em docs/adr/. Quer contribuir com um adapter? Veja CONTRIBUTING.md e comece pelo dossiê: docs/providers/README.md.

Site de documentação completo (com busca e a matriz de capabilities gerada do código): https://alltomatos.github.io/waconector/.

Desenvolvimento

npm install
npm test              # vitest (unit + suite de contrato)
npm run test:coverage # idem, com relatório e thresholds de cobertura
npm run typecheck     # tsc --noEmit
npm run lint          # biome
npm run build         # tsup → dist/ (ESM + CJS + tipos)
npm run smoke         # valida o pacote empacotado (exports ESM/CJS + fluxo completo)

npm run docs:capabilities # gera docs/capabilities.md a partir do código (roda após build)
npm run docs:dev          # site de documentação (VitePress) local, com hot reload
npm run docs:build        # build de produção do site em docs/.vitepress/dist
npm run docs:preview      # serve o build de produção localmente

Guia completo de contribuição (convenções, checklist de QA, como propor um adapter novo) em CONTRIBUTING.md.

Releases via changesets: npx changeset no PR; o merge em main abre o PR de versão e publica no npm com provenance (requer secret NPM_TOKEN no repositório).

Aviso legal

Este projeto é um client HTTP para APIs de terceiros e não é afiliado, associado, autorizado ou endossado pela Meta/WhatsApp. APIs não-oficiais violam os Termos de Serviço do WhatsApp e podem resultar em banimento de números. Use por sua conta e risco, preferencialmente em números dedicados.

Licença

MIT