acad-ts

TypeScript library to read and write AutoCAD DWG and DXF files. Ported from the C# ACadSharp library.

Based on commit: https://github.com/DomCR/ACadSharp/commit/3010994939c1bc21df0c9e2931e9baee4564815a

Features

• Read/Write DXF files (ASCII and binary)
• Read/Write DWG files
• Honor $DWGCODEPAGE when reading DXF ASCII/binary strings and when writing legacy-codepage text
• Extract and modify geometric entities (lines, arcs, circles, polylines, dimensions, etc.)
• Manage table entries (blocks, layers, line types, text styles, dimension styles)
• Convert CAD documents to SVG
• Full TypeScript type definitions

Supported DWG/DXF versions

| | DxfReader | DxfWriter | DwgReader | DwgWriter | | ------ | :-------: | :-------: | :-------: | :-------: | | AC1009 | :heavy_check_mark: | :x: | :x: | :x: | | AC1012 | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | | AC1014 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | AC1015 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | AC1018 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | AC1021 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | AC1024 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | AC1027 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | AC1032 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |

Installation

npm install @node-projects/acad-ts

Metadata-backed DXF mapping

The original C# ACadSharp implementation relies on reflection and attributes such as DxfCodeValue, DxfCollectionCodeValue, CadSystemVariable, DxfName, and DxfSubClass to build DXF maps and header-variable tables at runtime. TypeScript does not have the same runtime reflection model, so acad-ts now uses a checked-in metadata lookup table instead.

This metadata is what powers the rebuilt CadHeader.GetHeaderMap() / SetValue() path, DxfMap / DxfClassMap creation, DXF subclass lookup, and property conversions for dates, time spans, vectors, colors, reference types, and collection-coded values.

The metadata system has four parts:

• src/Metadata/MetadataLookupTable.ts: a small aggregator that preserves a stable runtime import path.
• src/Metadata/LookupTables/*.ts: the hand-maintained domain lookup tables for DXF names, subclass markers, property codes, collection codes, system variables, and reference semantics.
• src/Metadata/MetadataStore.ts: runtime lookup helpers that expose cloned metadata for maps, properties, and system variables.
• Runtime consumers such as src/DxfMap.ts, src/DxfClassMap.ts, src/DxfPropertyBase.ts, and src/Header/CadHeader.ts.

Why this exists:

• It restores the C# mapping behavior with an explicit TypeScript source of truth that lives in this repo.
• It avoids a build-time or maintenance dependency on the upstream C# source tree.
• It avoids shipping a decorator or reflection dependency just to emulate ACadSharp's attribute model.

How the lookup table is maintained:

1. The current lookup table was bootstrapped from the earlier generated metadata so the repo keeps the same runtime behavior without reintroducing the C# fetch step.
2. Ongoing changes should be made directly in the matching file under src/Metadata/LookupTables/ when a newly ported type, DXF code, collection code, subclass marker, or system variable needs to be added or corrected.
3. src/Metadata/MetadataLookupTable.ts aggregates those domain files into one array so the runtime import path stays stable.
4. src/Metadata/MetadataStore.ts clones that table before exposing entries so runtime consumers do not mutate the source data.

The lookup table is committed. Normal builds and tests consume the checked-in metadata and do not require network access or any external source tree.

Usage

Reading a DWG file

import fs from 'fs';
import { DwgReader } from '@node-projects/acad-ts';

const buffer = fs.readFileSync('drawing.dwg');
const arrayBuffer = buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength);

const doc = DwgReader.ReadFromStream(arrayBuffer, (sender, e) => {
  console.log(e.Message);
});

// Access entities in model space
for (const entity of doc.modelSpace.entities) {
  console.log(entity.constructor.name, entity.handle);
}

Reading a DXF file

import fs from 'fs';
import { DxfReader } from '@node-projects/acad-ts';

const buffer = fs.readFileSync('drawing.dxf');
const data = new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.byteLength);

const doc = DxfReader.ReadFromStream(data, (sender, e) => {
  console.log(e.Message);
});

DXF string decoding follows $DWGCODEPAGE for both ASCII and binary DXF. Pass the raw file bytes as Uint8Array; if you decode the file to a JavaScript string before handing it to the reader, the original code page information is already lost.

Writing a DWG file

import fs from 'fs';
import { CadDocument, DwgWriter, ACadVersion, Line, XYZ } from '@node-projects/acad-ts';

const doc = new CadDocument();
doc.header.version = ACadVersion.AC1032;

const line = new Line();
line.startPoint = new XYZ(0, 0, 0);
line.endPoint = new XYZ(100, 100, 0);
doc.modelSpace.addEntity(line);

const buffer = new ArrayBuffer(0);
DwgWriter.WriteToStream(buffer, doc);

Writing a DXF file

import { CadDocument, DxfWriter } from '@node-projects/acad-ts';

const doc = new CadDocument();
doc.header.codePage = 'ANSI_1252';
// ... add entities ...

const output = new Uint8Array(1024 * 1024);
const writer = new DxfWriter(output, doc);
writer.Write();

doc.header.codePage controls the legacy encoding used for DWG/DXF text data. For exact non-UTF-8 ASCII DXF bytes, prefer a Uint8Array target. If you send ASCII DXF to a string-based text sink, that sink's own encoding policy still determines the final bytes.

Exporting to SVG

import { SvgWriter } from '@node-projects/acad-ts';

const output = new Uint8Array(1024 * 1024);
const svgWriter = new SvgWriter(output, doc);
svgWriter.Write();

Working with entities

import { CadDocument, Layer, Line, Circle, XYZ, Color } from '@node-projects/acad-ts';

const doc = new CadDocument();

// Create a layer
const layer = new Layer();
layer.name = 'MyLayer';
layer.color = Color.fromColorIndex(1); // Red
doc.layers.add(layer);

// Add a line
const line = new Line();
line.startPoint = new XYZ(0, 0, 0);
line.endPoint = new XYZ(10, 5, 0);
line.layer = layer;
doc.modelSpace.addEntity(line);

// Add a circle
const circle = new Circle();
circle.center = new XYZ(5, 5, 0);
circle.radius = 3;
doc.modelSpace.addEntity(circle);

Building from source

npm install
npm run build

The compiled output will be in the dist/ directory.

Running tests

npm test

The focused metadata regression coverage lives in tests/MetadataMappings.test.ts. It verifies lookup-table collection codes, reference-type handling, CadHeader variable application, and metadata-backed DxfMap / DxfClassMap creation.

Documentation

See the docs folder for detailed documentation on specific topics:

• CadDocument - Document structure and collections
• CadObject - Base object properties
• Entities - Working with geometric entities
• Tables - Table entries (layers, line types, styles)
• Block Records - Blocks and block records
• Inserts - Block insertions
• Dimensions - Dimension entities
• Non-Graphical Objects - Layouts, dictionaries, etc.
• Reading files - Reader configuration and usage
• Writing files - Writer configuration and usage

License

MIT