\n\n[](https://www.gnu.org/licenses/gpl-3.0)\n\n\n\n\n\n[](https://www.npmjs.com/package/dxf-json)\n\nDXF parser with rich type definitions.\n\n> [!CAUTION]\n> This is parser is not in stable state yet. Until version 1.0, we may often change name or type of the variables. We're adding rich unit/integration test, but there might be unexpected bug or uncovered situation. Note that [official DXF specification](https://documentation.help/AutoCAD-DXF/) is poorly documented, so that many informations are missing and even errors exist. Use your own risk. Thank you for your consideration.\n\n## Quick Start\n\n```\nnpm i dxf-json # or your loved package manager\n```\n\n```ts\nimport { readFileSync } from 'fs'\nimport { DxfParser } from 'dxf-json'\n\nconst content = readFileSync('foo.dxf', 'utf-8')\nconst parser = new DxfParser()\nconst parsedDxf = parser.parseSync(content)\n\n// play with your dxf file\nconst lwPolylines = parsedDxf.entities.filter(\n (entity) => entity.type === 'LWPOLYLINE',\n)\n```\n\n### About `moduleResolution` in TypeScript\n\nIt's impossible to support both ESM and CJS with `node16`, because they detect type of modules only by `type` field in `package.json` or the extension of files. To support CJS with `node16`, we have to rename every `.d.ts` files into `.d.cts`, not only the file name but also every `import` expression in source files.\n\nBut Node16 is already deprecated, and to maintain the open source society healthy, we decided not to support `require` at that version. Also we **highly recommend to use ESM styled `import`** consistently throughout your source code.\n\n| Module Resolution | From ESM | From CJS |\n| ----------------- | -------- | -------- |\n| `node10` | ✅ | ✅ |\n| `node16` | ✅ | ❌ |\n| `bundler` | ✅ | ✅ |\n\n## Features\n\n- Synchronous parsing, asynchronous parsing, and url fetch are possible.\n- Support both ESM and CJS\n- Support TypeScript\n\n> [!NOTE]\n> We support standard specification of dxf and AutoCAD features only. We're trying our best to support universal dxf files, but we don't support 3rd party specification.\n\nCurrent Coverage\n\nFor `dev` branch status, see [#52](https://github.com/dotoritos-kim/dxf-json/issues/52)\n\nBased on [AutoCAD 2024 DXF Reference](https://help.autodesk.com/view/OARX/2024/ENU/?guid=GUID-235B22E0-A567-4CF6-92D3-38A2306D73F3)\n\n- [x] HEADER Section\n- [x] CLASSES Section\n- [x] TABLES Section\n - [x] APPID\n - [x] BLOCK_RECORD\n - [x] DIMSTYLE\n - [x] LAYER\n - [x] LTYPE\n - [x] STYLE\n - [x] UCS\n - [x] VIEW\n - [x] VPORT\n- [x] BLOCKS Section\n- [ ] ENTITIES Section\n - [x] 3DFACE\n - [x] 3DSOLID\n - [ ] ACAD_PROXY_ENTITY\n - [x] ARC\n - [x] ARC_DIMENSION\n - [x] ATTDEF\n - [x] ATTRIB\n - [x] BODY\n - [x] CIRCLE\n - [ ] COORDINATION MODEL\n - [x] DIMENSION\n - [x] ELLIPSE\n - [x] HATCH\n - [ ] HELIX\n - [x] IMAGE\n - [x] INSERT\n - [x] LEADER\n - [x] LIGHT\n - [x] LINE\n - [x] LWPOLYLINE\n - [x] MESH\n - [x] MLEADER\n - [ ] MLEADERSTYLE\n - [x] MLINE\n - [x] MTEXT\n - [ ] OLEFRAME\n - [ ] OLE2FRAME\n - [x] POINT\n - [x] POLYLINE\n - [x] RAY\n - [x] REGION\n - [x] SECTION\n - [ ] SEQEND\n - [ ] SHAPE\n - [x] SOLID\n - [x] SPLINE\n - [x] SUN\n - [ ] SURFACE\n - [ ] TABLE\n - [x] TEXT\n - [x] TOLERANCE\n - [ ] TRACE\n - [ ] UNDERLAY\n - [x] VERTEX\n - [x] VIEWPORT\n - [x] WIPEOUT\n - [x] XLINE\n- [ ] OBJECTS Section\n - [ ] DATATABLE\n - [x] DICTIONARY\n - [ ] DICTIONARYVAR\n - [ ] DIMASSOC\n - [ ] FIELD\n - [ ] GEODATA\n - [ ] GROUP\n - [ ] IDBUFFER\n - [ ] IMAGEDEF\n - [ ] IMAGEDEF_REACTOR\n - [ ] LAYER_FILTER\n - [ ] LAYER_INDEX\n - [x] LAYOUT\n - [ ] LIGHTLIST\n - [ ] MATERIAL\n - [ ] MLINESTYLE\n - [ ] OBJECT_PTR\n - [x] PLOTSETTINGS\n - [ ] RASTERVARIABLES\n - [ ] RENDER\n - [ ] SECTION\n - [ ] SORTENSTABLE\n - [x] SPATIAL_FILTER\n - [ ] SPATIAL_INDEX\n - [ ] SUNSTUDY\n - [ ] TABLESTYLE\n - [ ] UNDERLAYDEFINITION\n - [ ] VBA_PROJECT\n - [ ] VISUALSTYLE\n - [ ] WIPEOUTVARIABLES\n - [x] XRECORD\n- [x] THUMBNAILIMAGE Section\n\n\n\n> [!NOTE]\n> The documentation is not ready, but you can check the source code for used types [#1](https://github.com/dotoritos-kim/dxf-json/blob/main/src/parser/types.ts) and [#2](https://github.com/dotoritos-kim/dxf-json/blob/main/integration-test/src/types/import-test.ts)\n\n## Parsing Options\n\n### Thumbnail Image Format\n\nYou can configure how the `THUMBNAILIMAGE` section is parsed by setting the `thumbnailImageFormat` option:\n\n```ts\nimport { DxfParser } from 'dxf-json'\n\n// Default: base64 format (ready for web display)\nconst parser1 = new DxfParser()\nconst result1 = parser1.parseSync(dxfContent)\n// result1.thumbnailImage.data is a base64 string\n// Usage: \n\n// Hex format (raw hexadecimal string)\nconst parser2 = new DxfParser({ thumbnailImageFormat: 'hex' })\nconst result2 = parser2.parseSync(dxfContent)\n// result2.thumbnailImage.data is a hex string\n\n// Buffer format (Node.js Buffer object)\nconst parser3 = new DxfParser({ thumbnailImageFormat: 'buffer' })\nconst result3 = parser3.parseSync(dxfContent)\n// result3.thumbnailImage.data is a Buffer\n// Save to file: fs.writeFileSync('thumbnail.bmp', result3.thumbnailImage.data)\n```\n\n**Available formats:**\n- `'base64'` (default): Base64-encoded string, ideal for web applications\n- `'hex'`: Raw hexadecimal string from the DXF file\n- `'buffer'`: Node.js Buffer object for file operations\n\n> [!NOTE]\n> The thumbnail image in DXF files is typically in BMP format.\n\n### `parseSync`\n\n```ts\nconst parser = new DxfParser()\nreturn parser.parseSync(buffer)\n```\n\n### `parseStream`\n\n```ts\nimport fs from 'fs'\nconst parser = new DxfParser()\nconst fileStream = fs.createReadStream('dxf file path', { encoding: 'utf8' })\nreturn await parser.parseStream(fileStream)\n```\n\n### `parseUrl`\n\n```ts\nconst parser = new DxfParser()\nreturn await parser.parseFromUrl(url, encoding, RequestInit)\n```\n\n## Contribution\n\nSee [CONTRIBUTING.md](https://github.com/dotoritos-kim/dxf-json/blob/main/CONTRIBUTING.md)\n","readmeFilename":"Readme.md"}