bank-check-br

Biblioteca Node.js que valida bancos brasileiros e gera ícones SVG usando CSV oficial do Banco Central.

Visão Geral

bank-check-br une em uma única lib:

• Validação de dados bancários (código de agência, ISPB, nome)
• Ícones SVG de 40+ bancos brasileiros via @edusites/bancos-brasil
• Metadados oficiais do CSV do BCB
• Cache em memória para performance

Instalação

npm install bank-check-br

Uso Básico

import { validarBanco, buscarBanco, listarBancos, gerarSVG } from 'bank-check-br';

// Validar banco por código de agência
const banco = await validarBanco('001');
console.log(banco?.nomeExtenso); // "Banco do Brasil"

// Buscar com SVG incluído
const comSvg = await buscarBanco('001', { includeSvg: true });
console.log(comSvg?.svg); // "<svg>...</svg>"

// Listar todos os bancos
const todos = await listarBancos();

// Gerar SVG diretamente
const svg = gerarSVG('Itaú');

API

Funções de Conveniência

| Função | Descrição | |--------|-----------| | validarBanco(codigo, options?) | Valida e retorna banco por código | | buscarBanco(codigo, options?) | Busca banco por código de agência | | buscarBancoPorISPB(ispb, options?) | Busca banco por ISPB | | buscarBancosPorNome(nome, options?) | Busca bancos por nome | | listarBancos(filters?) | Lista todos os bancos | | listarBancosComIcone(options?) | Lista bancos com ícone SVG | | gerarSVG(nome, options?) | Gera SVG do banco | | recarregarDados() | Recarrega dados do BCB |

Opções

interface BankServiceOptions {
  includeSvg?: boolean;    // Incluir SVG na resposta
  svgOptions?: SVGOptions; // Opções de personalização do SVG
}

interface SVGOptions {
  width?: number;    // Largura do SVG (default: 24)
  height?: number;   // Altura do SVG (default: 24)
  className?: string; // Classe CSS
}

interface BankFilters {
  participaDaCompe?: string; // Filtrar por COMPE
  acessoPrincipal?: string;  // Filtrar por acesso
  comSvg?: boolean;          // Filtrar com ícone
}

Usando o Serviço Diretamente

import { BankService } from 'bank-check-br';

const service = new BankService();
await service.initialize();

const banco = await service.buscarBancoPorAgencia('001');
const comSvg = await service.buscarBancoPorAgencia('001', { includeSvg: true });

Bancos Suportados

A lib mapeia 40+ bancos brasileiros para SVGs:

| Banco | SVG Key | |-------|---------| | Banco do Brasil | bancodobrasil | | Itaú | itau | | Bradesco | bradesco | | Nubank | nubank | | Santander | santander | | C6 Bank | c6 | | Inter | inter | | BTG Pactual | btg | | XP | xp | | ... | ... |

TypeScript

A lib é escrita 100% em TypeScript com tipos completos:

import type { Banco, Participante, BankServiceOptions } from 'bank-check-br';

Build

npm run build    # Build ESM + CJS + DTS
npm test         # Rodar testes
npm run lint     # Verificar código
npm run format   # Formatar código

Licença

MIT

AI Assistant Skill

Esta lib inclui uma skill para assistentes de IA (Codex, Claude Code, etc.).

Instalação Automática

npm run install:skill

Detecta automaticamente o assistente instalado e copia a skill.

Instalação Manual

# Codex/OpenAI
cp -r node_modules/bank-check-br/skill/ ~/.codex/skills/bank-check-br/

# Claude Code
cp -r node_modules/bank-check-br/skill/ ~/.claude/skills/bank-check-br/

O que a skill faz

A skill fornece contexto completo sobre a API, tipos e exemplos de uso para que a AI possa ajudar a:

• Validar bancos brasileiros
• Gerar SVGs de bancos
• Buscar por código de agência ou ISPB
• Listar bancos com filtros

Autor

Dinho Silva - Desenvolvedor Fullstack

Contribuição

Veja CONTRIBUTING.md para guia de contribuição.