Skip to content

docs: versoes suportadas e depreciacao no npm de todas as versoes anteriores a 6 - #56

Draft
andrenfe wants to merge 3 commits into
masterfrom
docs/versoes-suportadas
Draft

andrenfe wants to merge 3 commits into
masterfrom
docs/versoes-suportadas

Conversation

@andrenfe

@andrenfe andrenfe commented Oct 17, 2026 •

Copy link
Copy Markdown
Member

O que muda

Documenta a política de versões do nfe-io: só a 6.x é suportada, e todas as versões anteriores à 6.0.0 ficam depreciadas no npm.

  • README: nova seção "Versões suportadas" (com entrada no índice). O título passa de "(v5)" para "(v6)".
  • CHANGELOG (Não lançado): item em Documentação e nova seção "Depreciado — registro, não código", com as faixas, o motivo de cada uma e o uso medido antes de depreciar.

Só documentação, sem mudança de código.

Faixas depreciadas no npm

Faixa Motivo No registry
<3.0.0 não verifica o certificado TLS (rejectUnauthorized: false em lib/BaseResource.js); webhooks em /v1/hooks, que dá 404 ✅ publicado
>=3.0.0 <3.2.1 validateSignature() rejeita toda assinatura legítima pendente (2FA)
3.2.1 última para Node.js 18/20, fora de suporte, sem as correções da 6.x pendente (2FA)
>=4.0.0 <6.0.0 métodos públicos que nunca alcançaram a API (corrigidos na 6.0.0) pendente (2FA)

A 3.2.1 foi incluída depois da primeira versão deste PR: ela tem os mesmos métodos quebrados da 4.x e da 5.x. A 6.0.0 fica de fora, porque o bug da 6.0.1 era latente.

O histórico tem um commit intermediário ("exceto a 3.2.1") que o último commit corrige. Sugiro squash no merge.

Verificação

  • npm run typecheck: limpo
  • npx vitest --run tests/unit: 46 arquivos, 791 testes passando, 6 pulados (inclui docs-drift)

A 6.x e a unica suportada. A 3.2.1 segue so com correcao critica de
seguranca ate 31/03/2027, por ser a ultima para Node.js 18 e 20. As
demais faixas foram depreciadas no npm, cada uma com o motivo e a versao
de destino. O titulo ainda dizia v5.
…o a 3.2.1

Registra as tres faixas, o motivo de cada uma e o uso medido em 30 dias
de gateway antes de depreciar.
@github-actions

Copy link
Copy Markdown

📋 OpenAPI Spec Validation

✅ All specs validated and types generated successfully

Specs processed:

  • calculo-impostos-v1.yaml - 27.90 KB, 853 lines
  • consulta-cnpj.yaml - 34.28 KB, 1128 lines
  • consulta-cpf.yaml - 3.39 KB, 83 lines
  • consulta-cte-v2.yaml - 18.33 KB, 578 lines
  • consulta-endereco.yaml - 11.17 KB, 343 lines
  • consulta-nf-consumidor.yaml - 43.41 KB, 1279 lines
  • consulta-nf.yaml - 137.87 KB, 3119 lines
  • consulta-nfe-distribuicao-v1.yaml - 53.07 KB, 1775 lines
  • nf-consumidor-v2.yaml - 293.87 KB, 7609 lines
  • nf-produto-v2.yaml - 309.41 KB, 8204 lines
  • nf-servico-v1.yaml - 257.67 KB, 6255 lines
  • nfeio.yaml - 15.86 KB, 630 lines
  • product-invoice-rtc-v1.yaml - 198.88 KB, 5084 lines
  • service-invoice-rtc-v1.yaml - 95.30 KB, 1728 lines

Generated types available as artifact in src/generated/.

A 3.2.1 tem os mesmos metodos quebrados da 4.x e da 5.x, depreciadas
pelo mesmo motivo, e o Node.js dela esta fora de suporte. Deixa-la sem
aviso dizia a quem esta nela que estava tudo certo. Sai o prazo de
31/03/2027 e a promessa de correcao de seguranca na 3.x.

As versoes <3.0.0 passam rejectUnauthorized: false e strictSSL: false
(lib/BaseResource.js na 1.0.0 e na 2.0.0), que e o motivo da mensagem
ja publicada no npm.
@github-actions

Copy link
Copy Markdown

📋 OpenAPI Spec Validation

✅ All specs validated and types generated successfully

Specs processed:

  • calculo-impostos-v1.yaml - 27.90 KB, 853 lines
  • consulta-cnpj.yaml - 34.28 KB, 1128 lines
  • consulta-cpf.yaml - 3.39 KB, 83 lines
  • consulta-cte-v2.yaml - 18.33 KB, 578 lines
  • consulta-endereco.yaml - 11.17 KB, 343 lines
  • consulta-nf-consumidor.yaml - 43.41 KB, 1279 lines
  • consulta-nf.yaml - 137.87 KB, 3119 lines
  • consulta-nfe-distribuicao-v1.yaml - 53.07 KB, 1775 lines
  • nf-consumidor-v2.yaml - 293.87 KB, 7609 lines
  • nf-produto-v2.yaml - 309.41 KB, 8204 lines
  • nf-servico-v1.yaml - 257.67 KB, 6255 lines
  • nfeio.yaml - 15.86 KB, 630 lines
  • product-invoice-rtc-v1.yaml - 198.88 KB, 5084 lines
  • service-invoice-rtc-v1.yaml - 95.30 KB, 1728 lines

Generated types available as artifact in src/generated/.

@andrenfe andrenfe changed the title docs: versoes suportadas e depreciacao no npm das versoes anteriores a 6 docs: versoes suportadas e depreciacao no npm de todas as versoes anteriores a 6 Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant