Giter Club home page Giter Club logo

node-boleto's Introduction

node-boleto

Standard - JavaScript Style Guide Quality Gate Status Coverage Maintainability Rating Reliability Rating Security Rating

Geração de boleto bancário em Node.js. Os algoritmos de geração da linha digitável e do código de barras foram inspirados no boletophp.

Bancos suportados

Instalação

npm install node-boleto

Exemplo de uso

Emitindo um boleto:

var Boleto = require('node-boleto').Boleto;

var boleto = new Boleto({
  'banco': "santander", // nome do banco dentro da pasta 'banks'
  'data_emissao': new Date(),
  'data_vencimento': new Date(new Date().getTime() + 5 * 24 * 3600 * 1000), // 5 dias futuramente
  'valor': 1500, // R$ 15,00 (valor em centavos)
  'nosso_numero': "1234567",
  'numero_documento': "123123",
  'cedente': "Pagar.me Pagamentos S/A",
  'cedente_cnpj': "18727053000174", // sem pontos e traços
  'agencia': "3978",
  'codigo_cedente': "6404154", // PSK (código da carteira)
  'carteira': "102"
});

console.log("Linha digitável: " + boleto['linha_digitavel'])

boleto.renderHTML(function(html){
  console.log(html);
});

Parseando o arquivo-retorno EDI do banco:

var ediParser = require('node-boleto').EdiParser,
	fs = require('fs');

var ediFileContent = fs.readFileSync("arquivo.txt").toString();

var parsedFile = ediParser.parse("santander", ediFileContent);

console.log("Boletos pagos: ");
console.log(parsedFile.boletos);

Adicionando novos bancos

Renderização do código de barras

Atualmente, há duas maneiras de renderizar o código de barras: img e bmp.

A engine img utiliza imagens brancas e pretas intercaladas para gerar o código de barras. Dessa forma, todos os browsers desde o IE6 são suportados. Esse modo de renderização, porém, é um pouco mais pesado, já que muitas divs são inseridas no HTML para a renderização.

A engine bmp aproveita da característica monodimensional dos códigos de barra e gera apenas a primeira linha de pixels do boleto, repetindo as outras linhas por CSS. É mais leve e funciona na maioria dos browser - IE apenas a partir da versão 8.

Para alterar a engine de renderização padrão:

Boleto.barcodeRenderEngine = 'bmp';

Licença

(The MIT License)

Copyright (c) 2013-2017 Pagar.me Pagamentos S/A

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

node-boleto's People

Contributors

adelmojnr avatar alinemarjorie avatar davidsmedeiros avatar derekstavis avatar felquis avatar greenboxal avatar grvcoelho avatar lucianopf avatar matheusvellone avatar osmanpontes avatar pedrofranceschi avatar ramonpaolo avatar samycici avatar theiostream avatar thor99 avatar travoul avatar vhaberkorn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

node-boleto's Issues

Erro na documentação

Excelente biblioteca!! Vi que mudou a parte de leitura de arquivos de retorno, mas faltou adequar a documentação inicial.

Em vez de :
var ediParser = require('node-boleto').ediParser,
para
var ediParser = require('node-boleto').EdiParser,

e
var parsedFile = ediParser.parse(ediFileContent);
para
var parsedFile = ediParser.parse("santander", ediFileContent);

Local date used instead of UTC in module

Many internal components of the module use Date arithmetic initializing it in the local timezone instead of in UTC, which generates complications across different timezones and for testing the module.

Erro por falta do 'moment'

O que eu fiz?

# criei um arquivo
nano boleto.js
# copiei e cole o código descrito no README.md deste repositório
# criei um projeto node.js
npm init -y
# instalei o node-boleto
npm install node-boleto
# executei o projeto
node .

Retornou um erro

node:internal/modules/cjs/loader:927
  throw err;
  ^

Error: Cannot find module 'moment'
Require stack:
- /app/node_modules/node-boleto/banks/bradesco/index.js
- /app/node_modules/node-boleto/index.js
- /app/boleto.js
    at Function.Module._resolveFilename (node:internal/modules/cjs/loader:924:15)
    at Function.Module._load (node:internal/modules/cjs/loader:769:27)
    at Module.require (node:internal/modules/cjs/loader:996:19)
    at require (node:internal/modules/cjs/helpers:92:18)
    at Object.<anonymous> (/app/node_modules/node-boleto/banks/bradesco/index.js:1:16)
    at Module._compile (node:internal/modules/cjs/loader:1092:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1121:10)
    at Module.load (node:internal/modules/cjs/loader:972:32)
    at Function.Module._load (node:internal/modules/cjs/loader:813:14)
    at Module.require (node:internal/modules/cjs/loader:996:19) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/app/node_modules/node-boleto/banks/bradesco/index.js',
    '/app/node_modules/node-boleto/index.js',
    '/app/boleto.js'
  ]
}

Ambiente

  • Debian GNU/Linux 9 (stretch)
  • Node.js v15.11.0
  • NPM 7.6.0

lib: trocar declaração de 'var' para 'const' / 'let'

Hoje no node-boleto temos muitas ocorrências de declarações de variáveis usando var. Tendo em vista que hoje a linguagem oferece formas mais otimizadas de declarar variáveis, seria interessante fazer a troca.

Dado que nossa pasta de lógica principal é a lib/, seria interessante trocar os var dos arquivos da pasta, para let / const, dependendo do caso.

Ocorrências:

https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L7
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L9
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L10
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L11
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L12
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L13
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L24
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L46
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L70
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L72
https://github.com/pagarme/node-boleto/blob/master/lib/boleto.js#L76
https://github.com/pagarme/node-boleto/blob/master/lib/edi-helper.js#L1
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L20
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L21
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L23
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L25
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L41
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L42
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L44
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L45
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L57
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L65
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L66
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L68
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L69
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L70
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L71
https://github.com/pagarme/node-boleto/blob/master/lib/formatters.js#L78

Novos parametros: Espécie Doc. e Aceite

Olá,

Antes de fazer um pr, gostaria de confirmar e sugerir uma melhoria.

Existem dois campos (puramente visuais) que estão fixos no "layout.ejs", que são "Espécie Doc." (com o valor fixo "DM") e "Aceite" (com valor fixo "N").

Estou criando dois novos paramêtros opcionais na criação do objeto "boleto", e que se não informados serão preenchidos com os valores fixos atuais.

Me informem se posso mardar um pr sobre isso.

Abraços a todos!

No error handling for required parameters for boleto generation

There are some node-boleto parameters that:

  • Are required and generated by default: data_vencimento.
  • Are optional and generated by default: data_emissao, local_de_pagamento.
  • Are optional and blank by default: instrucoes, pagador, cedente_cnpj, cedente, numero_documento.

These parameters require proper documentation.

  • Are required and don't error appropriately if not supplied: agencia, valor, carteira, codigo_cedente, nosso_numero.

These parameters require proper error handling.

print in pdf

Good afternoon, when printing the ticket in pdf printer the barcode loses its quality, is there any way or method implemented to print in pdf?

Este projeto ainda está sendo mantido?

Olá, gostaria de saber se o projeto ainda está sendo mantido, pois tem dois PRs abertos há mais de um ano e nem sequer passou por review de algum dos maintainers...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.