@jcsolutions/sender

⚠️ Aviso: Em desenvolvimento (alpha). A API pode mudar até a versão 1.0.0.

📌 Aviso de independência: Este projeto é de código aberto, independente e não é oficialmente afiliado, patrocinado ou endossado por nenhum dos provedores de SMS suportados. Os nomes dos provedores são marcas registradas de seus respectivos proprietários.

SDK para envio de SMS com suporte a gateways angolanos.

Introdução

O @jcsolutions/sender é uma biblioteca simples, extensível e type-safe para envio de SMS em aplicações Node.js. Foi construída com foco em developers angolanos que precisam integrar diferentes gateways de SMS (Ombala, KambaSMS, TelcoSMS, etc) sem reescrever lógica de integração.

Características principais

• API simples — Envie SMS com poucas linhas de código
• TypeScript first — Tipos completos e autocomplete
• Múltiplos providers — Ombala, KambaSMS, TelcoSMS e mais em breve
• Envio em lote — Suporte nativo para múltiplos destinatários
• Extensível — Adicione qualquer gateway através do registry pattern
• Fallback automático — Resiliência com múltiplos providers
• Retry automático — Configurável para maior confiabilidade

Recursos futuros

Consulte o Roadmap de melhorias para ver o que está planejado para as próximas versões.

Começar agora

Guia	Descrição
Primeiros passos	Instalação, configuração e primeiro envio
API Reference	Todas as funções, tipos e interfaces
Exemplos práticos	Códigos completos prontos para usar
Provider customizado	Como criar seu próprio provider
Roadmap	Funcionalidades planejadas

Providers suportados

Provider	Status	Documentação
Ombala	✅ Estável	docs
TelcoSMS	✅ Estável	docs
KambaSMS	🚧 Em desenvolvimento	docs

Instalação

yarn add @jcsolutions/sender
# ou
npm install @jcsolutions/sender

Uso rápido

import { createSender } from "@jcsolutions/sender";

const sms = await createSender("ombala", {
  token: process.env.OMBALA_TOKEN,
  baseUrl: "https://api.useombala.ao/v1",
  from: "LEVAJA",
});

const result = await sms.send({
  to: "923000000",
  message: "Seu código é 482913",
});

console.log(result.success ? "✅ Enviado" : "❌ Falha");

Licença

MIT © Justino Contingo