Skip to content

README.md

Latest commit

 

History

History
69 lines (44 loc) · 2.38 KB

README.md

File metadata and controls

69 lines (44 loc) · 2.38 KB

@precisa-saude/datasus-dbc

Decoder TypeScript puro de arquivos .dbc do DATASUS (xBase DBF + PKWARE DCL Implode). Browser e Node compatível, zero dependências nativas, licença Apache-2.0.

Motivação

Microdados públicos do DATASUS são distribuídos em .dbc — um formato dos anos 90 sem spec oficial. O ecossistema hoje se resolve em R (read.dbc) e Python (pyreaddbc, datasus-dbc). Em JS/TS existia apenas um Node native addon AGPLv3. Este pacote preenche a lacuna com uma implementação limpa em TypeScript.

Instalação

npm install @precisa-saude/datasus-dbc

Uso (preview)

import { readDbcRecords } from '@precisa-saude/datasus-dbc';

const file = await fetch('...').then((r) => r.arrayBuffer());
for await (const record of readDbcRecords(new Uint8Array(file))) {
  console.log(JSON.stringify(record));
}

API

Três camadas, expostas incrementalmente:

Alto nível — iterator de registros

readDbcRecords(source: Uint8Array, options?: ReadDbfOptions): AsyncIterable<DbfRecord>

Combina dbcToDbf + readDbfRecords. Retorna objetos JS com campos DBF tipados (strings, números, datas), prontos pra JSON.stringify.

Nível médio — envelope DBC → DBF

dbcToDbf(dbc: Uint8Array): Uint8Array
readDbcMetadata(dbc: Uint8Array): DbfHeaderInfo

Parseia o envelope DATASUS (header de 10 bytes + DBF header + DCL payload) e retorna o DBF descomprimido.

Baixo nível — DBF reader + DCL decompressor

readDbfHeader(dbf: Uint8Array): DbfHeader
readDbfRecords(dbf: Uint8Array, options?: ReadDbfOptions): AsyncIterable<DbfRecord>
implodeDecompress(compressed: Uint8Array, uncompressedLength: number): Uint8Array

implodeDecompress é um port do PKWARE DCL Implode em TS puro; use só se precisar processar payloads DCL fora do contexto DATASUS.

Tipos

DbfHeader, DbfField, DbfRecord, DbfValue, ReadDbfOptions, DbfHeaderInfo — todos exportados.

Referências

  • Mark Adler, blast.c — implementação canônica de DCL Implode em C
  • Daniela Petruzalek, DBC_FORMAT.md — spec do envelope DBC
  • pkwdcl.js — port JS de referência

Licença

Apache-2.0