Skip to content

Docs: páginas do portal conferidas contra o código (pós-6.0.1) - #54

Merged
andrenfe merged 1 commit into
masterfrom
chore/docs-signatures-v6
Oct 17, 2026
Merged

andrenfe merged 1 commit into
masterfrom
chore/docs-signatures-v6

Conversation

@andrenfe

@andrenfe andrenfe commented Oct 17, 2026 •

Copy link
Copy Markdown
Member

O que é

Só documentação, depois da 6.0.1. Não publica nada e não muda versão, porque docs/ não vai no
pacote do npm. Este PR vem antes da re-sincronização das páginas no portal de documentação.

O que estava errado

Comparei as páginas de docs/ com o código, pelo mesmo método usado na skill na 6.0.1. Elas tinham
assinaturas e retornos de antes da 6.0.0:

página problema
recursos/product-invoices.md createWithStateTax sem stateTaxId; sendCorrectionLetter com objeto, quando recebe reason: string, sem acento; downloads de NF-e e da CC-e como Buffer, quando devolvem { uri }; cancel, disable e disableRange com outro retorno
recursos/service-invoices.md downloads com invoiceId opcional e "ZIP da empresa", com um exemplo que não compila
recursos/state-taxes.md tipo StateTax, que não existe; exemplo que não compila em modo estrito
recursos/legal-entity-lookup.md getStateTaxInfo e os métodos de IE para emissão sem o parâmetro state; exemplo que não compila em modo estrito
recursos/legal-people.md, natural-people.md findByTaxNumber não indica que pode devolver undefined
downloads.md promete "Buffer sempre" e "ZIP por empresa"; diz que a NFC-e aceita environment; não lista distribuição nem CT-e
README.md (índice) fala em "bytes binários e ZIPs"

Legado da v3

docs/API.md, docs/EXTENDING.md e docs/EXTENSIBILITY_SUMMARY.md não têm frontmatter de portal
e só se referenciam entre si. No API.md há seções inteiras erradas: os exemplos de list,
cancel e sendEmail não funcionam na v6. Os três ganharam um aviso de legado no topo, que aponta
para as páginas mantidas, a skill e os tipos do pacote. O conteúdo não foi reescrito.

Verificação

páginas de recursos  comparação com o código: sobram só diferenças de nome de parâmetro
exemplos             os das páginas tocadas compilam em modo estrito
                     (strict, exactOptionalPropertyTypes, noUncheckedIndexedAccess)
controle negativo    4 usos da versão anterior não compilam
docs-drift           verde (links relativos, métodos citados, métodos sem caminho de sucesso)
unit                 791 passed | 6 skipped

Depois do merge

Re-sincronizar as páginas da biblioteca Node no portal de documentação (tarefa 8.8 da 6.0.1). A
descrição desse PR passa pela sua aprovação antes de ele ser aberto.

As paginas de docs/ que o portal espelha tinham assinaturas e retornos
de antes da 6.0.0:

  recursos/product-invoices     createWithStateTax sem stateTaxId;
                                sendCorrectionLetter recebia objeto (e
                                reason: string, sem acento); downloads
                                de NF-e e da CC-e como Buffer (devolvem
                                NfeFileResource, { uri }); cancel,
                                disable e disableRange com outro retorno
  recursos/service-invoices     downloads com invoiceId opcional e "ZIP
                                da empresa", com exemplo que nao compila
  recursos/state-taxes          tipo StateTax, que nao existe (e
                                NfeStateTax); exemplo com
                                stateTaxes[0].id, que nao compila em
                                modo estrito
  recursos/legal-entity-lookup  getStateTaxInfo e os de IE para emissao
                                sem o parametro state; exemplo que nao
                                compila em modo estrito
  recursos/legal-people,        findByTaxNumber pode devolver undefined
  recursos/natural-people
  downloads.md                  "Buffer sempre" e "ZIP por empresa";
                                NFC-e com environment; faltavam
                                distribuicao e CT-e
  README.md (indice)            "bytes binarios e ZIPs"

API.md, EXTENDING.md e EXTENSIBILITY_SUMMARY.md sao da v3: nao tem
frontmatter de portal e so se referenciam entre si. No API.md ha secoes
inteiras erradas, nao so assinaturas. Por decisao do Andre, ganham aviso
de legado no topo, apontando para as paginas mantidas, a skill e os
tipos do pacote; o conteudo nao e reescrito.

Verificado: a comparacao mecanica das paginas de recursos com o codigo
fica so com diferencas de nome de parametro; os exemplos das paginas
tocadas compilam em modo estrito, e quatro usos da versao anterior nao
compilam.
@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 merged commit 749a4e8 into master Oct 17, 2026
13 checks passed
@andrenfe
andrenfe deleted the chore/docs-signatures-v6 branch October 17, 2026 01:05
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