@br-validators/core 1.3.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/README.md +39 -14
  2. package/dist/aeroportos.d.ts +46 -0
  3. package/dist/aeroportos.js +4316 -0
  4. package/dist/aeroportos.js.map +1 -0
  5. package/dist/batch.js +3 -3
  6. package/dist/cest.d.ts +44 -0
  7. package/dist/cest.js +8253 -0
  8. package/dist/cest.js.map +1 -0
  9. package/dist/chunk-475HS4CJ.js +30 -0
  10. package/dist/chunk-475HS4CJ.js.map +1 -0
  11. package/dist/chunk-6EF7GQRS.js +30 -0
  12. package/dist/chunk-6EF7GQRS.js.map +1 -0
  13. package/dist/{chunk-QB7SZS2C.js → chunk-6UEXR2MQ.js} +4 -4
  14. package/dist/{chunk-QB7SZS2C.js.map → chunk-6UEXR2MQ.js.map} +1 -1
  15. package/dist/chunk-7JCJGLA3.js +30 -0
  16. package/dist/chunk-7JCJGLA3.js.map +1 -0
  17. package/dist/chunk-EKOSTVIA.js +30 -0
  18. package/dist/chunk-EKOSTVIA.js.map +1 -0
  19. package/dist/chunk-F7IEPT22.js +30 -0
  20. package/dist/chunk-F7IEPT22.js.map +1 -0
  21. package/dist/chunk-FUYDR7JI.js +44 -0
  22. package/dist/chunk-FUYDR7JI.js.map +1 -0
  23. package/dist/chunk-ILKF7HP7.js +31 -0
  24. package/dist/chunk-ILKF7HP7.js.map +1 -0
  25. package/dist/chunk-NTVB7R3A.js +30 -0
  26. package/dist/chunk-NTVB7R3A.js.map +1 -0
  27. package/dist/{chunk-QK27VDVB.js → chunk-NXS343IJ.js} +4 -4
  28. package/dist/{chunk-QK27VDVB.js.map → chunk-NXS343IJ.js.map} +1 -1
  29. package/dist/chunk-O4AO4YWC.js +30 -0
  30. package/dist/chunk-O4AO4YWC.js.map +1 -0
  31. package/dist/{chunk-SKDMG3FK.js → chunk-Q5QBTTNC.js} +6 -6
  32. package/dist/{chunk-SKDMG3FK.js.map → chunk-Q5QBTTNC.js.map} +1 -1
  33. package/dist/{chunk-ITHT54NC.js → chunk-QU4HTXM5.js} +4 -4
  34. package/dist/{chunk-ITHT54NC.js.map → chunk-QU4HTXM5.js.map} +1 -1
  35. package/dist/chunk-RWO34ORS.js +33 -0
  36. package/dist/chunk-RWO34ORS.js.map +1 -0
  37. package/dist/{chunk-S4WWYHQM.js → chunk-VWS4AWCI.js} +3 -3
  38. package/dist/{chunk-S4WWYHQM.js.map → chunk-VWS4AWCI.js.map} +1 -1
  39. package/dist/{chunk-DYX5XSJ6.js → chunk-X7XQRG4X.js} +3 -3
  40. package/dist/{chunk-DYX5XSJ6.js.map → chunk-X7XQRG4X.js.map} +1 -1
  41. package/dist/{chunk-NHFSEWO2.js → chunk-YNUYQKUW.js} +4 -4
  42. package/dist/{chunk-NHFSEWO2.js.map → chunk-YNUYQKUW.js.map} +1 -1
  43. package/dist/chunk-ZWAYSR5K.js +30 -0
  44. package/dist/chunk-ZWAYSR5K.js.map +1 -0
  45. package/dist/{chunk-ZTDLGGYE.js → chunk-ZYWBWXTJ.js} +4 -4
  46. package/dist/{chunk-ZTDLGGYE.js.map → chunk-ZYWBWXTJ.js.map} +1 -1
  47. package/dist/compare.js +4 -4
  48. package/dist/data-catalog.js +33 -11
  49. package/dist/data-catalog.js.map +1 -1
  50. package/dist/detect.js +3 -3
  51. package/dist/diff.js +4 -4
  52. package/dist/generate.js +5 -5
  53. package/dist/incoterms.d.ts +36 -0
  54. package/dist/incoterms.js +87 -0
  55. package/dist/incoterms.js.map +1 -0
  56. package/dist/index.js +17 -17
  57. package/dist/mask.js +5 -5
  58. package/dist/moedas.d.ts +42 -0
  59. package/dist/moedas.js +977 -0
  60. package/dist/moedas.js.map +1 -0
  61. package/dist/natureza-juridica.d.ts +37 -0
  62. package/dist/natureza-juridica.js +398 -0
  63. package/dist/natureza-juridica.js.map +1 -0
  64. package/dist/nbs.d.ts +40 -0
  65. package/dist/nbs.js +3728 -0
  66. package/dist/nbs.js.map +1 -0
  67. package/dist/paises-bacen.d.ts +35 -0
  68. package/dist/paises-bacen.js +1044 -0
  69. package/dist/paises-bacen.js.map +1 -0
  70. package/dist/pncp-reference.d.ts +56 -0
  71. package/dist/pncp-reference.js +1560 -0
  72. package/dist/pncp-reference.js.map +1 -0
  73. package/dist/portos.d.ts +48 -0
  74. package/dist/portos.js +12094 -0
  75. package/dist/portos.js.map +1 -0
  76. package/dist/sanitize.js +3 -3
  77. package/dist/transparencia-snapshots.d.ts +61 -0
  78. package/dist/transparencia-snapshots.js +119 -0
  79. package/dist/transparencia-snapshots.js.map +1 -0
  80. package/dist/tse-municipios.d.ts +39 -0
  81. package/dist/tse-municipios.js +33469 -0
  82. package/dist/tse-municipios.js.map +1 -0
  83. package/package.json +56 -1
package/README.md CHANGED
@@ -29,7 +29,7 @@ Every Brazilian SaaS eventually reinvents CPF validation — usually wrong.
29
29
  - ✅ **Zero runtime dependencies** — pure TypeScript logic, no HTTP calls
30
30
  - ✅ **Never throws** — every function returns `{ ok: true, value } | { ok: false, message, code }`
31
31
  - ✅ **Tree-shakeable** — subpath imports per document type
32
- - ✅ **Reference data** — IBGE, Bacen banks, DDD lookup, national holidays, CNAE, CFOP, NCM, CBO — embedded offline with weekly freshness ([DATA-FRESHNESS.md](../../docs/DATA-FRESHNESS.md))
32
+ - ✅ **Reference data** — IBGE, Bacen banks, DDD lookup, national holidays, CNAE, CFOP, NCM, CBO, natureza jurídica, NBS, CEST, moedas, países Bacen, Incoterms, portos, aeroportos — embedded offline with weekly freshness ([DATA-FRESHNESS.md](../../docs/DATA-FRESHNESS.md))
33
33
  - ✅ **ESM only**, Node ≥ 18, works in browser, Bun, Deno
34
34
 
35
35
  ---
@@ -262,18 +262,27 @@ br-validators generate inscricao-estadual-produtor-rural --masked --seed 42
262
262
 
263
263
  Embedded JSON from official `.gov.br` sources — **no runtime HTTP**. Each module exports `*_DATA_VERSION` with capture date, row counts, and source URLs. Aggregated via `@br-validators/core/data-catalog`.
264
264
 
265
- | Dataset | Subpath | Key APIs | Official source |
266
- |---------|---------|----------|-----------------|
267
- | IBGE states + municipalities | `@br-validators/core/ibge` | `getEstados`, `getMunicipios`, `getMunicipioPorCodigo` | [IBGE localidades API](https://servicodados.ibge.gov.br/api/docs/localidades) |
268
- | Bacen STR banks (COMPE / ISPB) | `@br-validators/core/bancos` | `getBancos`, `getBancoPorCodigo`, `getBancoPorIspb` | [Bacen Participantes STR](https://www.bcb.gov.br/content/estabilidadefinanceira/str1/ParticipantesSTR.csv) |
269
- | DDD geographic lookup | `@br-validators/core/telefone` | `getDddInfo` (extends telefone validator) | [Anatel DDD panel](https://informacoes.anatel.gov.br/paineis/areas-tarifarias/codigos-nacionais) |
270
- | National holidays | `@br-validators/core/feriados` | `isFeriadoNacional`, `getFeriadosNacionais`, `getProximoDiaUtil` | [Lei 662/1949](https://www.planalto.gov.br/ccivil_03/leis/l0662.htm) + annual Portaria MGI |
271
- | CNAE 2.3 subclasses | `@br-validators/core/cnaes` | `getCnaePorCodigo`, `searchCnaes` | [IBGE CNAE API v2](https://servicodados.ibge.gov.br/api/docs/cnae) |
272
- | CFOP fiscal operations | `@br-validators/core/cfop` | `getCfopPorCodigo`, `searchCfop` | [CONFAZ CFOP SINIEF](https://www.confaz.fazenda.gov.br/legislacao/ajustes/sinief/cfop_cvsn_70_vigente) |
273
- | NCM Mercosur nomenclature | `@br-validators/core/ncm` | `getNcmPorCodigo`, `searchNcm` | [Siscomex NCM JSON](https://portalunico.siscomex.gov.br/classif/api/publico/nomenclatura/download/json) |
274
- | CBO 2002 occupations | `@br-validators/core/cbo` | `getCboPorCodigo`, `searchCbo` | [MTE CBO downloads](https://www.gov.br/trabalho-e-emprego/pt-br/assuntos/cbo/servicos/downloads) |
275
- | CEP prefix lookup | `@br-validators/core/cep` | `getCepFaixaInfo`, `getCepFaixas` | [IBGE CNEFE 2022](https://www.ibge.gov.br/estatisticas/sociais/populacao/38734-cadastro-nacional-de-enderecos-para-fins-estatisticos.html) |
276
- | Data transparency catalog | `@br-validators/core/data-catalog` | `getDataCatalog`, `getDatasetMetadata` | Aggregates all `metadata.json` entries |
265
+ | Dataset | Subpath | CLI | Playground | Key APIs | Official source |
266
+ |---------|---------|-----|------------|----------|-----------------|
267
+ | IBGE states + municipalities | `@br-validators/core/ibge` | — | `/data/ibge` | `getEstados`, `getMunicipios`, `getMunicipioPorCodigo` | [IBGE localidades API](https://servicodados.ibge.gov.br/api/docs/localidades) |
268
+ | Bacen STR banks (COMPE / ISPB) | `@br-validators/core/bancos` | `bancos lookup` · `list` | `/data/bancos` | `getBancos`, `getBancoPorCodigo`, `getBancoPorIspb` | [Bacen Participantes STR](https://www.bcb.gov.br/content/estabilidadefinanceira/str1/ParticipantesSTR.csv) |
269
+ | ANAC public aerodromos | `@br-validators/core/aeroportos` | `aeroportos lookup` | `/data/logistics` | `getAeroportos`, `getAeroportoPorIata`, `getAeroportoPorIcao`, `getAeroportosPorMunicipio` | [ANAC aeródromos públicos CSV](https://www.anac.gov.br/acesso-a-informacao/dados-abertos/areas-de-atuacao/aerodromos/lista-de-aerodromos-publicos/aerodromospublicosv1.csv/@@download/file/aerodromospublicosv1.csv) |
270
+ | ANTAQ port installations | `@br-validators/core/portos` | `portos lookup` | `/data/logistics` | `getPortoPorCodigo`, `searchPortos`, `getPortosPorMunicipio` | [ANTAQ instalações portuárias zip](https://www.gov.br/antaq/pt-br/central-de-conteudos/Instalaesporturias06052025.zip) |
271
+ | TSE IBGE municipality codes | `@br-validators/core/tse-municipios` | — | — | `getMapeamentoTseIbge`, `getMunicipioIbgePorCodigoTse`, `getCodigosTsePorMunicipio` | [TSE municipio_tse_ibge.zip](https://cdn.tse.jus.br/estatistica/sead/odsele/municipio_tse_ibge/municipio_tse_ibge.zip) |
272
+ | DDD geographic lookup | `@br-validators/core/telefone` | | — | `getDddInfo` (extends telefone validator) | [Anatel DDD panel](https://informacoes.anatel.gov.br/paineis/areas-tarifarias/codigos-nacionais) |
273
+ | National holidays | `@br-validators/core/feriados` | — | — | `isFeriadoNacional`, `getFeriadosNacionais`, `getProximoDiaUtil` | [Lei 662/1949](https://www.planalto.gov.br/ccivil_03/leis/l0662.htm) + annual Portaria MGI |
274
+ | CNAE 2.3 subclasses | `@br-validators/core/cnaes` | — | — | `getCnaePorCodigo`, `searchCnaes` | [IBGE CNAE API v2](https://servicodados.ibge.gov.br/api/docs/cnae) |
275
+ | CFOP fiscal operations | `@br-validators/core/cfop` | — | — | `getCfopPorCodigo`, `searchCfop` | [CONFAZ CFOP SINIEF](https://www.confaz.fazenda.gov.br/legislacao/ajustes/sinief/cfop_cvsn_70_vigente) |
276
+ | NCM Mercosur nomenclature | `@br-validators/core/ncm` | — | — | `getNcmPorCodigo`, `searchNcm` | [Siscomex NCM JSON](https://portalunico.siscomex.gov.br/classif/api/publico/nomenclatura/download/json) |
277
+ | Natureza jurídica (CNPJ) | `@br-validators/core/natureza-juridica` | `natureza-juridica lookup` | `/data/fiscal` | `getNaturezaJuridicaPorCodigo` | [RFB Naturezas.zip](https://dadosabertos.rfb.gov.br/CNPJ/dados_abertos_cnpj/) |
278
+ | NBS (NFSe Nacional) | `@br-validators/core/nbs` | `nbs lookup` | `/data/fiscal` | `getNbsPorCodigo`, `searchNbs` | [NFSe Anexo B NBS2 xlsx](https://www.gov.br/nfse/pt-br/biblioteca/documentacao-tecnica/documentacao-atual/anexo_b-nbs2-lista_servico_nacional-snnfse.xlsx) |
279
+ | CEST (substituição tributária) | `@br-validators/core/cest` | `cest lookup` | `/data/fiscal` | `getCestPorCodigo`, `getCestPorNcm`, `searchCest` | [CONFAZ ICMS 142/2018](https://www.confaz.fazenda.gov.br/legislacao/convenios/2018/CV142_18) |
280
+ | ISO 4217 + Bacen PTAX moedas | `@br-validators/core/moedas` | `moedas lookup` | `/data/trade` | `getMoedaPorCodigo`, `searchMoedas` | [Bacen PTAX Moedas API](https://olinda.bcb.gov.br/olinda/servico/PTAX/versao/v1/odata/Moedas) |
281
+ | NF-e Bacen country codes | `@br-validators/core/paises-bacen` | `paises-bacen lookup` | `/data/trade` | `getPaisPorCodigoBacen`, `getPaisesBacen` | [NF-e country table](http://www.nfe.fazenda.gov.br/portal/exibirArquivo.aspx?conteudo=FOXZNFX/p50=) |
282
+ | ICC Incoterms 2020 | `@br-validators/core/incoterms` | `incoterms lookup` | `/data/trade` | `getIncotermPorCodigo`, `getIncoterms` | [ICC Incoterms rules](https://iccwbo.org/resources-for-business/incoterms-rules/) |
283
+ | CBO 2002 occupations | `@br-validators/core/cbo` | — | — | `getCboPorCodigo`, `searchCbo` | [MTE CBO downloads](https://www.gov.br/trabalho-e-emprego/pt-br/assuntos/cbo/servicos/downloads) |
284
+ | CEP prefix lookup | `@br-validators/core/cep` | — | — | `getCepFaixaInfo`, `getCepFaixas` | [IBGE CNEFE 2022](https://www.ibge.gov.br/estatisticas/sociais/populacao/38734-cadastro-nacional-de-enderecos-para-fins-estatisticos.html) |
285
+ | Data transparency catalog | `@br-validators/core/data-catalog` | — | `/data/catalog` | `getDataCatalog`, `getDatasetMetadata` | Aggregates all `metadata.json` entries |
277
286
 
278
287
  ```typescript
279
288
  import { getMunicipioPorCodigo } from '@br-validators/core/ibge';
@@ -284,6 +293,14 @@ import { getCnaePorCodigo } from '@br-validators/core/cnaes';
284
293
  import { getCfopPorCodigo } from '@br-validators/core/cfop';
285
294
  import { getNcmPorCodigo } from '@br-validators/core/ncm';
286
295
  import { getCboPorCodigo } from '@br-validators/core/cbo';
296
+ import { getNaturezaJuridicaPorCodigo } from '@br-validators/core/natureza-juridica';
297
+ import { getNbsPorCodigo } from '@br-validators/core/nbs';
298
+ import { getCestPorCodigo } from '@br-validators/core/cest';
299
+ import { getMoedaPorCodigo } from '@br-validators/core/moedas';
300
+ import { getPaisPorCodigoBacen } from '@br-validators/core/paises-bacen';
301
+ import { getIncotermPorCodigo } from '@br-validators/core/incoterms';
302
+ import { getAeroportoPorIata } from '@br-validators/core/aeroportos';
303
+ import { getPortoPorCodigo } from '@br-validators/core/portos';
287
304
  import { getDataCatalog } from '@br-validators/core/data-catalog';
288
305
 
289
306
  getMunicipioPorCodigo(3550308)?.nome; // São Paulo
@@ -294,7 +311,15 @@ getCnaePorCodigo('6201501'); // custom software development
294
311
  getCfopPorCodigo('1.102'); // accepts CONFAZ dotted format
295
312
  getNcmPorCodigo('01012100'); // purebred horses (8-digit leaf)
296
313
  getCboPorCodigo('212405'); // systems development analyst
297
- getDataCatalog().length; // 8 registered datasets
314
+ getNaturezaJuridicaPorCodigo('2062'); // Sociedade Empresária Limitada
315
+ getNbsPorCodigo('1.1502.50.00'); // TI systems integration (NFSe)
316
+ getCestPorCodigo('0302100'); // returnable beer bottle (ST)
317
+ getMoedaPorCodigo('BRL')?.nome; // Real Brasileiro
318
+ getPaisPorCodigoBacen('1058')?.nome; // Brasil (NF-e cPais)
319
+ getIncotermPorCodigo('FOB')?.nome; // Free On Board
320
+ getAeroportoPorIata('GRU')?.nome; // Guarulhos — SP
321
+ getPortoPorCodigo('BRSSZ')?.nome; // Santos organized port
322
+ getDataCatalog().length; // registered datasets
298
323
  ```
299
324
 
300
325
  Freshness table (auto-updated weekly): [docs/DATA-FRESHNESS.md](https://github.com/AlexandreZanata/br-validators/blob/main/docs/DATA-FRESHNESS.md) · Per-type official URLs: [docs/OFFICIAL-SOURCES.md](https://github.com/AlexandreZanata/br-validators/blob/main/docs/OFFICIAL-SOURCES.md)
@@ -0,0 +1,46 @@
1
+ import { b as DatasetChanges, c as DatasetVerification } from './types-CBIZxgfG.js';
2
+
3
+ interface Aeroporto {
4
+ iata: string | null;
5
+ icao: string;
6
+ nome: string;
7
+ uf: string;
8
+ municipioIbge: number | null;
9
+ municipioNome: string | null;
10
+ }
11
+ interface AeroportosDataVersion {
12
+ id: 'aeroportos';
13
+ nome: string;
14
+ fonte: string;
15
+ endpoints: string[];
16
+ capturadoEm: string;
17
+ atualizadoEm: string;
18
+ contagens: {
19
+ aeroportos: number;
20
+ comIata: number;
21
+ };
22
+ alteracoes: DatasetChanges;
23
+ verificacao: DatasetVerification;
24
+ documentacao: string;
25
+ }
26
+
27
+ /**
28
+ * Brazilian airports — offline embedded data from official ANAC source.
29
+ * @see docs/OFFICIAL-SOURCES.md#aeroportos
30
+ */
31
+
32
+ declare function getAeroportos(): readonly Aeroporto[];
33
+ declare function getAeroportoPorIata(code: string): Aeroporto | undefined;
34
+ declare function getAeroportoPorIcao(code: string): Aeroporto | undefined;
35
+ declare function getAeroportosPorMunicipio(ibgeCodigo: number): readonly Aeroporto[];
36
+
37
+ declare const ANAC_AERODROMOS_PUBLICOS_CSV_URL = "https://www.anac.gov.br/acesso-a-informacao/dados-abertos/areas-de-atuacao/aerodromos/lista-de-aerodromos-publicos/aerodromospublicosv1.csv/@@download/file/aerodromospublicosv1.csv";
38
+ declare const AEROPORTOS_GOLDEN_IATA_GRU = "GRU";
39
+ declare const AEROPORTOS_GOLDEN_IATA_GIG = "GIG";
40
+ declare const AEROPORTOS_GOLDEN_IATA_BSB = "BSB";
41
+ declare const AEROPORTOS_GOLDEN_IATA_SSA = "SSA";
42
+ declare const AEROPORTOS_GOLDEN_IATA_CGB = "CGB";
43
+
44
+ declare const AEROPORTOS_DATA_VERSION: AeroportosDataVersion;
45
+
46
+ export { AEROPORTOS_DATA_VERSION, AEROPORTOS_GOLDEN_IATA_BSB, AEROPORTOS_GOLDEN_IATA_CGB, AEROPORTOS_GOLDEN_IATA_GIG, AEROPORTOS_GOLDEN_IATA_GRU, AEROPORTOS_GOLDEN_IATA_SSA, ANAC_AERODROMOS_PUBLICOS_CSV_URL, type Aeroporto, type AeroportosDataVersion, getAeroportoPorIata, getAeroportoPorIcao, getAeroportos, getAeroportosPorMunicipio };