@rebound-dlq/node 0.1.0 → 0.2.0

package/README.md

@@ -1,103 +1,106 @@
-# Rebound DLQ SDK 🚀
+# Rebound DLQ for Node.js
 
-O **Rebound DLQ SDK** é uma solução de altíssima performance (Zero Gargalos e Fila em Memória) para capturar falhas em integrações, proteger sua regra de negócio e fazer o reprocessamento de DLQs (Dead Letter Queues) de forma transparente para sua aplicação Node.js.
+[![NPM Version](https://img.shields.io/npm/v/@rebound-dlq/node)](https://www.npmjs.com/package/@rebound-dlq/node)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Sua aplicação original não vai travar nem ficar lenta, mesmo se a nossa API cair ou a rede oscilar.
+O **@rebound-dlq/node** é o SDK oficial em Node.js para integração com a plataforma **[Rebound DLQ](https://rebound-dlq.com)**.
 
-## 📦 1. Instalação
+Este pacote permite capturar falhas em integrações (APIs de terceiros, pagamentos, envio de e-mails, etc.) de forma transparente para a sua aplicação Node.js. Sem travar sua regra de negócio e sem adicionar latência. Quando uma operação falha, o SDK captura o payload, criptografa a informação e envia o evento em plano de fundo (background) para a sua conta no Rebound DLQ, aplicando estratégias de retry exponencial automaticamente se houver instabilidade na rede.
 
-Abra o terminal do seu projeto Node.js e instale o pacote:
+## Por que usar o Rebound DLQ?
 
-```bash
-npm install @rebound/dlq-sdk
-```
-
-*(Nota: Se você está rodando um pacote em testes local via `.tgz`, use: `npm install ./caminho/do/seu/rebound-dlq-sdk-0.1.0.tgz`)*
+- ⚡ **Zero Latência (In-Memory Queue)**: A aplicação não espera a resposta do envio do log para a nossa infraestrutura. A execução ocorre inteiramente em memória e em background, liberando o processo Node.js principal na hora (`O(1)`).
+- 🛡️ **Segurança e Criptografia Local**: Todo o payload de erro é criptografado localmente na sua máquina (usando AES-256) antes mesmo de trafegar pela rede. Seus dados chegam anônimos na nossa infraestrutura, e somente você consegue descriptografá-los com a sua chave secreta.
+- 🔁 **Resiliência e Retentativa Automática**: Falhas de rede ou indisponibilidade? O SDK mantém o evento a salvo em memória e aplica _backoff exponencial_ para garantir a entrega quando a conexão for reestabelecida.
 
----
+> ⚠️ **Atenção**: Este SDK requer uma conta ativa na plataforma **[Rebound DLQ](https://rebound-dlq.com)**.
 
-## ⚙️ 2. Como Configurar e Usar na Prática
+## Instalação
 
-A forma ideal de utilizar o SDK é "abraçando" (envolvendo) as funções de risco do seu sistema (pagamentos, cadastros em APIs externas, envio de emails, etc) através do `DlqWrapper`.
+Abra o terminal e instale o pacote via npm, yarn ou pnpm:
 
-### Passo A: Importar e Configurar o SDK
+```bash
+npm install @rebound-dlq/node
+```
 
-No topo do seu arquivo principal (ou no seu arquivo de injeção de dependências), inicialize o Wrapper passando suas credenciais:
+## Configuração Segura
 
-```javascript
-// Se você usa CommonJS (require):
-const { DlqWrapper } = require('@rebound/dlq-sdk');
+O SDK só precisa da chave de integração do seu projeto (`projectSecret`). 
 
-// Se você usa ES Modules (import):
-// import { DlqWrapper } from '@rebound/dlq-sdk';
+**Prática Recomendada:** Nunca exponha (hard-code) a sua chave diretamente no código-fonte. Armazene a sua chave `projectSecret` de forma segura utilizando variáveis de ambiente (ex: arquivo `.env`).
 
-const dlqWrapper = new DlqWrapper({
-  projectId: "seu-project-id", // Pegue no painel do Rebound
-  projectSecret: "sk_dev_sua_chave_secreta", // Use sk_dev_ para testes ou sk_live_ para produção
-});
+```env
+# Arquivo .env
+REBOUND_PROJECT_SECRET="sk_dev_sua_chave_secreta_aqui"
 ```
 
-### Passo B: Proteger sua Função
+> **Dica de Ambiente**:
+> - Chaves iniciadas com `sk_dev_` enviarão eventos automaticamente para o ambiente de testes/sandbox.
+> - Chaves iniciadas com `sk_live_` enviarão eventos para o ambiente de produção.
 
-Em vez de chamar sua função diretamente, chame ela *dentro* do método `.execute()` do SDK. 
+## Uso Básico
 
-Sempre que a sua função der erro, o SDK silenciosamente vai capturar o payload e enviar pra Rebound em backgroud, enquanto sua aplicação segue a vida imediatamente e de forma limpa.
+A forma ideal de utilizar o SDK é encapsular a sua função com o método `.execute()` oferecido pela classe `DlqWrapper`. 
 
-```javascript
-// Uma função sua que costuma falhar ou chamar serviços externos
-async function minhaFuncaoDeRisco(dados) {
-    console.log("Iniciando pagamento...");
-    if (dados.valor > 1000) {
-        throw new Error("Saldo insuficiente na operadora do cartão");
-    }
-    return "Sucesso!";
+Se atente à inicialização e uso:
+
+```typescript
+import { DlqWrapper } from '@rebound-dlq/node';
+
+// Inicializa o SDK consumindo de variáveis de ambiente
+const dlq = new DlqWrapper({
+  projectSecret: process.env.REBOUND_PROJECT_SECRET,
+});
+
+// A função que se conecta ao seu provedor ou ao seu banco de dados (que pode falhar)
+async function processarPagamento(dados) {
+  if (dados.valor > 1000) {
+    throw new Error('Saldo insuficiente na operadora do cartão');
+  }
+  return 'Sucesso!';
 }
 
-async function run() {
-    // 1. Defina os dados que você quer salvar caso essa rotina falhe
-    const payloadQueSeraSalvoNaDLQ = { 
-        userId: "123", 
-        valor: 5000, 
-        tentativa: 1,
-        modulo: "Checkout"
-    };
-    
-    try {
-        // 2. Execute a sua função DENTRO da proteção do SDK
-        const resultado = await dlqWrapper.execute(
-            () => minhaFuncaoDeRisco(payloadQueSeraSalvoNaDLQ), // Sua função de negócio
-            payloadQueSeraSalvoNaDLQ // O Payload que vai pra nuvem em caso de erro
-        );
-        
-        console.log("Deu tudo certo:", resultado);
-
-    } catch (erro) {
-        // 3. Trate o erro localmente como você sempre fez (o App NÃO morre)
-        console.log("Erro na aplicação:", erro.message);
-        
-        // 🚀 A MÁGICA:
-        // Nesse exato momento, o SDK já pegou esse erro e despachou para o Rebound na nuvem.
-        // Se a internet falhou, ele salvou na memória RAM e ficará tentando de novo em background
-        // sem travar ou deixar sua API mais lenta!
-    }
+async function main() {
+  // Os dados de contexto que você gostaria de analisar depois se algo der errado
+  const payloadQueSeraSalvoNaDLQ = {
+    userId: '123',
+    valor: 5000,
+    tentativa: 1,
+    modulo: 'Checkout',
+  };
+
+  try {
+    console.log("Iniciando transação...");
+
+    // Protegemos a função com o wrapper. Se der erro dentro de processarPagamento,
+    // o dlq envia os detalhes do erro E o payloadQueSeraSalvoNaDLQ para o Rebound automatically!
+    const resultado = await dlq.execute(
+      () => processarPagamento(payloadQueSeraSalvoNaDLQ),
+      payloadQueSeraSalvoNaDLQ
+    );
+
+    console.log('Finalizado com:', resultado);
+
+  } catch (erro) {
+    // A aplicação não morre; o erro é lançado apenas para seu tratamento habitual
+    console.log('Aconteceu um erro previsto na aplicação:', erro.message);
+  }
 }
 
-run();
+main();
 ```
 
----
-
-## ⚡ Por que usar nossa DLQ Engine?
+### O que acontece por baixo dos panos neste exemplo?
 
-1. **In-Memory Zero-Latency**: A comunicação com nossos servidores não engargala os verbos HTTP da sua aplicação. Assim que a exceção bater e você usar o wrapper, ele joga o payload rápido (`O(1)`) pra uma fila inteligente em Memória RAM da sua máquina.
-2. **Entrega Garantida**: Se a sua infra ou nossa nuvem apresentar lentidão, sua requisição fica salva temporariamente no Node Event Loop da sua aplicação fazendo "Retry Exponencial" silencioso.
-3. **Criptografia Automática**: Todas as requisições enviadas ao Painel são criptografadas (AES-256) com sua `projectSecret` ainda na sua infraestrutura. Ninguém acessa do outro lado além de você.
+1. Ao chamar `.execute()`, se o `processarPagamento` lançar qualquer **exceção**.
+2. Essa exceção é **capturada sem dor**.
+3. A variável `payloadQueSeraSalvoNaDLQ` entra na **memória RAM do SDK**.
+4. É processada **criptografia local AES-256** no dado, utilizando a sua chave.
+5. Em Background, um processo envia de forma segura este evento para a plataforma Rebound, garantindo entrega do Dead Letter Queue para reprocessamento futuro ou simples visualização pela Dashboard.
 
-### Modos suportados
+## Suporte
 
-- `sk_dev_*` conectará automaticamente na Sandbox / Local (Porta 3001)
-- `sk_live_*` conectará aos endpoints oficiais estabilizados de produção.
+Em caso de dúvidas, problemas de implementação ou bugs, abra um chamado pela Dashboard oficial do [Rebound Platform](https://rebound-dlq.com).
 
----
-**Suporte Rebound**  
-Dúvidas ou problemas? Acesse seu dashboard e abra um chamado com nosso time de engenharia.
+***
+_Feito com ❤️ por **[Codify Labs] / [Rebound DLQ]**._

package/dist/core/wrapper.d.ts

@@ -1,11 +1,9 @@
 export interface DlqServiceConfig {
-    projectId: string;
     projectSecret: string;
     endpoint?: string;
     maxFailures?: number;
 }
 export declare class DlqWrapper {
-    private projectId;
     private projectSecret;
     private readonly endpoint;
     constructor(config: DlqServiceConfig);

package/dist/core/wrapper.js

@@ -9,7 +9,6 @@ const constants_1 = require("./constants");
 const queue_1 = require("./queue");
 class DlqWrapper {
     constructor(config) {
-        this.projectId = config.projectId;
         this.projectSecret = config.projectSecret;
         // Identifica se é ambiente de teste através do projectSecret (mesma lógica da apiKey no ReboundClient)
         const isTest = config.projectSecret.startsWith('sk_dev_');
@@ -35,7 +34,6 @@ class DlqWrapper {
         const fingerprint = this.generateFingerprint(error);
         const encryptedPayload = this.encrypt(payload);
         const data = {
-            projectId: this.projectId,
             fingerprint,
             error: {
                 name: error.name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebound-dlq/node",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": ["dist"],