diff --git a/CLAUDE.md b/CLAUDE.md index e45f10b..2eadc10 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -73,3 +73,12 @@ Dual format via tsdown (Rolldown): ESM (`dist/index.js`) + CommonJS (`dist/index - Run `npm run generate` after modifying any OpenAPI spec in `openapi/spec/` - Typecheck and tests must pass before commits (`npm run typecheck && npm test -- --run`) - The CHANGELOG is written in Portuguese +- `docs/` is mirrored to the public documentation portal + (; `README.md` becomes the index page; + `EXTENDING.md` and `EXTENSIBILITY_SUMMARY.md` stay here). Keep the machine frontmatter the portal + uses as search facets on every page: + - `tags` with `nodejs`, the page type, the fiscal document and the subject; + - `integration: [sdk]`; + - `status: deprecated` for pages out of circulation. + + Sync with a three-way merge, never by copying over: the portal edits these pages too. diff --git a/docs/API.md b/docs/API.md index 565a8e2..407b998 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,3 +1,10 @@ +--- +tags: [nodejs, referencia] +integration: [sdk] +status: deprecated +superseded_by: /docs/desenvolvedores/bibliotecas/node +--- + # NFE.io SDK v3 - API Reference > ⚠️ **Legacy reference (v3), not maintained.** This file was written for the 3.x SDK and is no diff --git a/docs/README.md b/docs/README.md index 54d6457..f40c1e3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,6 +9,8 @@ layout_type: IntegrationLayout heroImage: /docs/img/bibliotecas/nodejs.svg ctaLabel: GitHub NFE.io Node.js ctaUrl: https://github.com/nfe/client-nodejs +tags: [nodejs, nfse, nfe, nfce, cte, how-to] +integration: [sdk] --- # Biblioteca Node.js NFE.io diff --git a/docs/async-and-polling.md b/docs/async-and-polling.md index b7a7e71..85e0870 100644 --- a/docs/async-and-polling.md +++ b/docs/async-and-polling.md @@ -4,6 +4,8 @@ sidebar_label: Assíncrono e polling sidebar_position: 3 slug: assincrono-e-polling description: Retorno discriminado (202 vs 201), estados de FlowStatus, createAndWait/cancelAndWait e emissão webhook-driven. +tags: [nodejs, nfse, nfe, nfce, emissao, referencia] +integration: [sdk] --- # Emissão assíncrona e polling diff --git a/docs/configuration.md b/docs/configuration.md index ac7dac0..2bf9a4f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -4,6 +4,8 @@ sidebar_label: Configuração sidebar_position: 2 slug: configuracao description: Chaves de API (apiKey e dataApiKey), ambiente, timeout, retry e reconfiguração em runtime do NfeClient. +tags: [nodejs, autenticacao, referencia] +integration: [sdk] --- # Configuração diff --git a/docs/downloads.md b/docs/downloads.md index 866b102..d8f20bf 100644 --- a/docs/downloads.md +++ b/docs/downloads.md @@ -4,6 +4,8 @@ sidebar_label: Downloads (PDF/XML) sidebar_position: 6 slug: downloads-pdf-xml description: Baixe DANFE/PDF e XML de uma nota identificada, em bytes (Buffer) ou por link, conforme o recurso. +tags: [nodejs, nfse, nfe, nfce, cte, xml, referencia] +integration: [sdk] --- # Downloads (PDF/XML) diff --git a/docs/errors.md b/docs/errors.md index 510b7a4..8d5dcd0 100644 --- a/docs/errors.md +++ b/docs/errors.md @@ -4,6 +4,8 @@ sidebar_label: Erros sidebar_position: 8 slug: erros description: Hierarquia de erros (NfeError), type guards, mapeamento de status HTTP e política de retry. +tags: [nodejs, erro, referencia] +integration: [sdk] --- # Erros diff --git a/docs/getting-started.md b/docs/getting-started.md index 53a9799..8f1cef6 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,6 +4,8 @@ sidebar_label: Primeiros passos sidebar_position: 1 slug: primeiros-passos description: Instale o pacote nfe-io, crie um NfeClient, emita sua primeira NFS-e e acompanhe o processamento com createAndWait/polling. +tags: [nodejs, nfse, emissao, how-to] +integration: [sdk] --- # Primeiros passos diff --git a/docs/multi-host-routing.md b/docs/multi-host-routing.md index d0f0d25..418efb0 100644 --- a/docs/multi-host-routing.md +++ b/docs/multi-host-routing.md @@ -4,6 +4,8 @@ sidebar_label: Multi-host / multi-chave sidebar_position: 4 slug: multi-host-e-multi-chave description: A NFE.io é composta por várias APIs em hosts distintos e duas chaves (principal e de dados). Entenda qual recurso usa qual host e chave. +tags: [nodejs, autenticacao, referencia] +integration: [sdk] --- # Roteamento multi-host / multi-chave diff --git a/docs/pagination.md b/docs/pagination.md index 646192a..c1e4d08 100644 --- a/docs/pagination.md +++ b/docs/pagination.md @@ -4,6 +4,8 @@ sidebar_label: Paginação sidebar_position: 5 slug: paginacao description: Listas page-style com filtros de data, envelopes de resposta por recurso e iteração automática de empresas. +tags: [nodejs, paginacao, referencia] +integration: [sdk] --- # Paginação diff --git a/docs/recursos/addresses.md b/docs/recursos/addresses.md index e377ea0..9e73129 100644 --- a/docs/recursos/addresses.md +++ b/docs/recursos/addresses.md @@ -4,6 +4,8 @@ sidebar_label: Endereços (CEP) sidebar_position: 11 slug: consulta-cep description: Consulte endereços por CEP com nfe.addresses (host address.api.nfe.io). Suporta apenas lookup por CEP; retorna um Address único. +tags: [nodejs, consulta, referencia] +integration: [sdk] --- # Consulta de endereço (CEP) diff --git a/docs/recursos/certificates.md b/docs/recursos/certificates.md index 9d7958a..7f1597c 100644 --- a/docs/recursos/certificates.md +++ b/docs/recursos/certificates.md @@ -4,6 +4,8 @@ sidebar_label: Certificados sidebar_position: 7 slug: certificados description: Consulta e remoção de certificados digitais por thumbprint com nfe.certificates (host api.nfse.io), com variantes v1. +tags: [nodejs, certificado, referencia] +integration: [sdk] --- # Certificados (por thumbprint) diff --git a/docs/recursos/companies.md b/docs/recursos/companies.md index 5041a97..9a22533 100644 --- a/docs/recursos/companies.md +++ b/docs/recursos/companies.md @@ -4,6 +4,8 @@ sidebar_label: Empresas sidebar_position: 4 slug: empresas description: CRUD de empresas emitentes, iteração paginada, verificação de existência e gestão de certificados digitais com nfe.companies. +tags: [nodejs, empresa, referencia] +integration: [sdk] --- # Empresas (emitentes) diff --git a/docs/recursos/consumer-invoice-query.md b/docs/recursos/consumer-invoice-query.md index e1a11cd..55a7622 100644 --- a/docs/recursos/consumer-invoice-query.md +++ b/docs/recursos/consumer-invoice-query.md @@ -4,6 +4,9 @@ sidebar_label: Consulta CFe-SAT sidebar_position: 21 slug: consulta-cfe-sat description: nfe.consumerInvoiceQuery consulta cupons CFe-SAT por chave de acesso — métodos descontinuados, porque a plataforma não serve as rotas. +tags: [nodejs, consulta, referencia] +integration: [sdk] +status: deprecated --- # Consulta de cupom (CFe-SAT) diff --git a/docs/recursos/consumer-invoices.md b/docs/recursos/consumer-invoices.md index 9bcad2a..b2f1306 100644 --- a/docs/recursos/consumer-invoices.md +++ b/docs/recursos/consumer-invoices.md @@ -4,6 +4,8 @@ sidebar_label: NFC-e (consumidor) sidebar_position: 3 slug: nfc-e description: Emita e gerencie NFC-e com nfe.consumerInvoices no host api.nfse.io — emissão webhook-driven e environment obrigatório na listagem/leituras. +tags: [nodejs, nfce, emissao, referencia] +integration: [sdk] --- # NFC-e (notas de consumidor) diff --git a/docs/recursos/inbound-product-invoices.md b/docs/recursos/inbound-product-invoices.md index 7036b4d..24fc488 100644 --- a/docs/recursos/inbound-product-invoices.md +++ b/docs/recursos/inbound-product-invoices.md @@ -4,6 +4,8 @@ sidebar_label: NF-e de entrada sidebar_position: 19 slug: nfe-de-entrada description: Captura automática de NF-e de entrada (distribuição DF-e) com nfe.inboundProductInvoices (host api.nfse.io). +tags: [nodejs, nfe, inbound, distribuicao, referencia] +integration: [sdk] --- # NF-e de entrada (inbound) diff --git a/docs/recursos/legal-entity-lookup.md b/docs/recursos/legal-entity-lookup.md index 23d48ec..00faaf7 100644 --- a/docs/recursos/legal-entity-lookup.md +++ b/docs/recursos/legal-entity-lookup.md @@ -4,6 +4,8 @@ sidebar_label: Consulta CNPJ sidebar_position: 12 slug: consulta-cnpj description: Consulte dados cadastrais e de inscrição estadual por CNPJ com nfe.legalEntityLookup (host legalentity.api.nfe.io). +tags: [nodejs, consulta, referencia] +integration: [sdk] --- # Consulta de CNPJ diff --git a/docs/recursos/legal-people.md b/docs/recursos/legal-people.md index 778d8df..77489c2 100644 --- a/docs/recursos/legal-people.md +++ b/docs/recursos/legal-people.md @@ -4,6 +4,8 @@ sidebar_label: Pessoas jurídicas sidebar_position: 14 slug: pessoas-juridicas description: CRUD de pessoas jurídicas (tomadores) por empresa com nfe.legalPeople, incluindo criação em lote e busca por CNPJ. +tags: [nodejs, referencia] +integration: [sdk] --- # Pessoas jurídicas (tomadores PJ) diff --git a/docs/recursos/municipal-taxes.md b/docs/recursos/municipal-taxes.md index 581b6f7..f12bc6f 100644 --- a/docs/recursos/municipal-taxes.md +++ b/docs/recursos/municipal-taxes.md @@ -4,6 +4,8 @@ sidebar_label: Inscrições municipais sidebar_position: 5 slug: inscricoes-municipais description: CRUD de inscrições municipais (pré-requisito da NFS-e) com nfe.municipalTaxes, incluindo a semântica de substituição do update (PUT). +tags: [nodejs, nfse, inscricao-municipal, referencia] +integration: [sdk] --- # Inscrições municipais diff --git a/docs/recursos/natural-people.md b/docs/recursos/natural-people.md index 6325ec1..2b7ea4d 100644 --- a/docs/recursos/natural-people.md +++ b/docs/recursos/natural-people.md @@ -4,6 +4,8 @@ sidebar_label: Pessoas físicas sidebar_position: 15 slug: pessoas-fisicas description: CRUD de pessoas físicas (tomadores) por empresa com nfe.naturalPeople, incluindo criação em lote e busca por CPF. +tags: [nodejs, referencia] +integration: [sdk] --- # Pessoas físicas (tomadores PF) diff --git a/docs/recursos/natural-person-lookup.md b/docs/recursos/natural-person-lookup.md index 943ea19..98dcd5a 100644 --- a/docs/recursos/natural-person-lookup.md +++ b/docs/recursos/natural-person-lookup.md @@ -4,6 +4,8 @@ sidebar_label: Consulta CPF sidebar_position: 13 slug: consulta-cpf description: Consulte a situação cadastral de um CPF com nfe.naturalPersonLookup (host naturalperson.api.nfe.io). Requer data de nascimento. +tags: [nodejs, consulta, referencia] +integration: [sdk] --- # Consulta de CPF diff --git a/docs/recursos/notifications.md b/docs/recursos/notifications.md index 7f59419..0747a27 100644 --- a/docs/recursos/notifications.md +++ b/docs/recursos/notifications.md @@ -4,6 +4,8 @@ sidebar_label: Notificações sidebar_position: 8 slug: notificacoes description: Liste, consulte, remova e envie por e-mail as notificações da empresa com nfe.notifications (host api.nfe.io). +tags: [nodejs, notificacao, referencia] +integration: [sdk] --- # Notificações diff --git a/docs/recursos/product-invoice-query.md b/docs/recursos/product-invoice-query.md index c9a5478..1abee21 100644 --- a/docs/recursos/product-invoice-query.md +++ b/docs/recursos/product-invoice-query.md @@ -4,6 +4,8 @@ sidebar_label: Consulta NF-e sidebar_position: 20 slug: consulta-nfe description: Consulte NF-e por chave de acesso e baixe PDF/XML com nfe.productInvoiceQuery (host nfe.api.nfe.io). +tags: [nodejs, consulta, nfe, referencia] +integration: [sdk] --- # Consulta de NF-e por chave (SEFAZ) diff --git a/docs/recursos/product-invoices.md b/docs/recursos/product-invoices.md index df595c9..de5b194 100644 --- a/docs/recursos/product-invoices.md +++ b/docs/recursos/product-invoices.md @@ -4,6 +4,8 @@ sidebar_label: Notas de produto sidebar_position: 2 slug: notas-fiscais-de-produto description: Emita e gerencie NF-e com nfe.productInvoices no host api.nfse.io — emissão webhook-driven, carta de correção, downloads e inutilização. +tags: [nodejs, nfe, emissao, referencia] +integration: [sdk] --- # Notas fiscais de produto (NF-e) diff --git a/docs/recursos/rtc.md b/docs/recursos/rtc.md index b8ee05f..dc77bee 100644 --- a/docs/recursos/rtc.md +++ b/docs/recursos/rtc.md @@ -4,6 +4,8 @@ sidebar_label: RTC sidebar_position: 10 slug: recursos-rtc description: Recursos de emissão no leiaute RTC — serviceInvoicesRtc (NFS-e) e productInvoicesRtc (NF-e/NFC-e). +tags: [nodejs, nfse, nfe, nfce, rtc, reforma-tributaria, emissao, referencia] +integration: [sdk] --- # RTC (recursos) diff --git a/docs/recursos/service-invoices.md b/docs/recursos/service-invoices.md index 1765947..5adc5c2 100644 --- a/docs/recursos/service-invoices.md +++ b/docs/recursos/service-invoices.md @@ -4,6 +4,8 @@ sidebar_label: Notas de serviço sidebar_position: 1 slug: notas-fiscais-de-servico description: Emita, liste, consulte, cancele e baixe NFS-e com nfe.serviceInvoices no host api.nfe.io /v1, tratando o retorno discriminado 202. +tags: [nodejs, nfse, emissao, referencia] +integration: [sdk] --- # Notas fiscais de serviço (NFS-e) diff --git a/docs/recursos/state-taxes.md b/docs/recursos/state-taxes.md index f9fd33d..a7d6cdd 100644 --- a/docs/recursos/state-taxes.md +++ b/docs/recursos/state-taxes.md @@ -4,6 +4,8 @@ sidebar_label: Inscrições estaduais sidebar_position: 6 slug: inscricoes-estaduais description: CRUD de inscrições estaduais (pré-requisito da NF-e) com nfe.stateTaxes, incluindo troca de autorizador (switchAuthorizer). +tags: [nodejs, nfe, inscricao-estadual, referencia] +integration: [sdk] --- # Inscrições estaduais diff --git a/docs/recursos/tax-calculation.md b/docs/recursos/tax-calculation.md index 6dd4580..e9c2628 100644 --- a/docs/recursos/tax-calculation.md +++ b/docs/recursos/tax-calculation.md @@ -4,6 +4,8 @@ sidebar_label: Cálculo de impostos sidebar_position: 17 slug: calculo-de-impostos description: Calcule tributos (ICMS, PIS, COFINS, IPI, II) por item com nfe.taxCalculation (host api.nfse.io). +tags: [nodejs, impostos, referencia] +integration: [sdk] --- # Cálculo de impostos diff --git a/docs/recursos/tax-codes.md b/docs/recursos/tax-codes.md index 52faa56..1b7da67 100644 --- a/docs/recursos/tax-codes.md +++ b/docs/recursos/tax-codes.md @@ -4,6 +4,8 @@ sidebar_label: Códigos de tributos sidebar_position: 16 slug: codigos-de-tributos description: Liste códigos de operação, finalidade de aquisição e perfis fiscais com nfe.taxCodes (host api.nfse.io, chave principal). +tags: [nodejs, impostos, catalogo, referencia] +integration: [sdk] --- # Códigos auxiliares (tax codes) diff --git a/docs/recursos/transportation-invoices.md b/docs/recursos/transportation-invoices.md index 8962b24..2f322b0 100644 --- a/docs/recursos/transportation-invoices.md +++ b/docs/recursos/transportation-invoices.md @@ -4,6 +4,8 @@ sidebar_label: CT-e (transporte) sidebar_position: 18 slug: cte-transporte description: Habilite e consulte CT-e por chave de acesso com nfe.transportationInvoices (host api.nfse.io). +tags: [nodejs, cte, inbound, referencia] +integration: [sdk] --- # CT-e (conhecimento de transporte) diff --git a/docs/recursos/webhooks.md b/docs/recursos/webhooks.md index b5d9ac1..f074d52 100644 --- a/docs/recursos/webhooks.md +++ b/docs/recursos/webhooks.md @@ -4,6 +4,8 @@ sidebar_label: Webhooks sidebar_position: 9 slug: recurso-webhooks description: Métodos de webhooks por conta, verificação de assinatura e lista de eventos ao vivo com nfe.webhooks. +tags: [nodejs, webhook, referencia] +integration: [sdk] --- # Webhooks (recurso) diff --git a/docs/rtc-emission.md b/docs/rtc-emission.md index a902402..5a1be3e 100644 --- a/docs/rtc-emission.md +++ b/docs/rtc-emission.md @@ -4,6 +4,8 @@ sidebar_label: Emissão RTC sidebar_position: 9 slug: emissao-rtc description: Emita NFS-e e NF-e/NFC-e no leiaute RTC (IBS/CBS/IS). O RTC é selecionado pelo payload, no mesmo endpoint da emissão atual. +tags: [nodejs, nfse, nfe, nfce, rtc, reforma-tributaria, emissao, referencia] +integration: [sdk] --- # Emissão RTC (Reforma Tributária do Consumo) diff --git a/docs/webhooks.md b/docs/webhooks.md index ab42925..8415902 100644 --- a/docs/webhooks.md +++ b/docs/webhooks.md @@ -4,6 +4,8 @@ sidebar_label: Webhooks sidebar_position: 7 slug: webhooks description: Verificação de assinatura HMAC-SHA1 (x-hub-signature), webhooks por empresa e por conta, e lista de eventos ao vivo. +tags: [nodejs, webhook, referencia] +integration: [sdk] --- # Webhooks