Delfinance SDK - Node.js

SDK oficial para integração com os serviços financeiros da Delbank, desenvolvido em TypeScript para Node.js 14+.

Requisitos

• Node.js + TypeScript

Instalação

npm install del-sdk

⚙️ Configuração (mTLS)

Para o ambiente de Produção, é obrigatório o uso de certificados mTLS. Certifique-se de ter os arquivos .key e .pem/.crt disponíveis.

🛠️ Como usar

1. Inicializando o Cliente O SDK utiliza o padrão Factory para garantir que todas as configurações de rede e segurança sejam aplicadas corretamente.

• Crie um arquivo .env na raiz do projeto

    import { SdkClientFactory, delEnvironment, delSdkOptions } from './src/index';

    function getEnv(name: string): string {
        const value = process.env[name];
        if (!value) {
            throw new Error(`Env ${name} não definida`);
        }
        return value;
    }

    const options: delSdkOptions = {
        environment: delEnvironment.Sandbox,
        accessToken: getEnv('AUTH_ACCOUNT_API_KEY'),
        accountId: getEnv('AUTH_ACCOUNT_ID'),
        timeout: 30000,
        // Obrigatório em Produção:
        mtlsClientCertificate: fs.readFileSync('./certs/producao.crt'),
        mtlsClientKey: fs.readFileSync('./certs/producao.key')
    };

    const pixClient = SdkClientFactory.createPixServicesClient(options);

📂 Estrutura do Projeto

• src/configurations: Gerenciamento de ambientes e Factory.

• src/services: Implementação dos clientes de API (Pix, etc).

• src/utils: Utilitários de rede (HttpClient).

• src/shared/common: Tipagens e DTOs comuns.

Instalação

Instale as dependências de desenvolvimento:

npm install
# Ou se estiver instalando do zero:
# npm install --save-dev ts-node typescript

🧩 Requisitos adicionais para TypeScript

Se você estiver usando este SDK em um projeto TypeScript, certifique-se de instalar os tipos do Node.js para evitar erros de compilação relacionados aos módulos nativos (https, crypto etc):

npm install --save-dev @types/node

⚠️ Nota: Este SDK é projetado para ambientes Node.js e pode não funcionar corretamente em projetos frontend (React, Angular, etc.) sem adaptações específicas.

Notas de Versão

• 0.1.0 - Piloto