@linkiez/dxf-renew 7.1.0 → 7.2.3

package/src/types/entity.ts

@@ -10,14 +10,24 @@ import type { ImageEntity } from './image-entity'
 import type { InsertEntity } from './insert-entity'
 import type { LeaderEntity } from './leader-entity'
 import type { LineEntity } from './line-entity'
+import type { MLeaderEntity } from './mleader-entity'
+import type { MLineEntity } from './mline-entity'
 import type { MTextEntity } from './mtext-entity'
+import type { OleFrameEntity } from './oleframe-entity'
 import type { PointEntity } from './point-entity'
 import type { PolylineEntity } from './polyline-entity'
+import type { RayEntity } from './ray-entity'
+import type { RegionEntity } from './region-entity'
+import type { ShapeEntity } from './shape-entity'
 import type { SolidEntity } from './solid-entity'
 import type { SplineEntity } from './spline-entity'
+import type { TableEntity } from './table-entity'
 import type { TextEntity } from './text-entity'
 import type { ToleranceEntity } from './tolerance-entity'
+import type { TraceEntity } from './trace-entity'
 import type { DgnUnderlayEntity, DwfUnderlayEntity, PdfUnderlayEntity } from './underlay-entity'
+import type { WipeoutEntity } from './wipeout-entity'
+import type { XLineEntity } from './xline-entity'
 
 export type Entity =
   | LineEntity
@@ -29,14 +39,24 @@ export type Entity =
   | PointEntity
   | PolylineEntity
   | SplineEntity
+  | TableEntity
   | DimensionEntity
   | SolidEntity
+  | TraceEntity
   | InsertEntity
   | ImageEntity
   | LeaderEntity
+  | MLineEntity
+  | MLeaderEntity
   | ToleranceEntity
   | DwfUnderlayEntity
   | DgnUnderlayEntity
   | PdfUnderlayEntity
   | HatchEntity
   | BaseEntity
+  | OleFrameEntity
+  | RayEntity
+  | RegionEntity
+  | ShapeEntity
+  | WipeoutEntity
+  | XLineEntity

package/src/types/helper.ts

@@ -2,11 +2,12 @@
 
 import type { ParsedDXF } from './dxf'
 import type { Entity } from './entity'
-import type { ToPolylinesOptions, ToSVGOptions } from './options'
+import type { ToJsonOptions, ToPolylinesOptions, ToSVGOptions } from './options'
 
 export interface HelperInterface {
   parsed: ParsedDXF
   denormalised: Entity[]
   toSVG(options?: ToSVGOptions): string
+  toJson(options?: ToJsonOptions): string
   toPolylines(options?: ToPolylinesOptions): any[]
 }

package/src/types/index.ts

@@ -16,16 +16,26 @@ export * from './image-entity'
 export * from './insert-entity'
 export * from './leader-entity'
 export * from './line-entity'
+export * from './mleader-entity'
+export * from './mline-entity'
 export * from './mtext-entity'
 export * from './ole2frame-entity'
+export * from './oleframe-entity'
 export * from './point-entity'
 export * from './polyline-entity'
+export * from './ray-entity'
+export * from './region-entity'
+export * from './shape-entity'
 export * from './solid-entity'
 export * from './spline-entity'
+export * from './table-entity'
 export * from './text-entity'
 export * from './tolerance-entity'
+export * from './trace-entity'
 export * from './underlay-entity'
 export * from './viewport-entity'
+export * from './wipeout-entity'
+export * from './xline-entity'
 
 // Union type
 export * from './entity'

package/src/types/mleader-entity.ts

@@ -0,0 +1,8 @@
+import type { BaseEntity } from './base-entity'
+
+export interface MLeaderEntity extends BaseEntity {
+  type: 'MLEADER'
+
+  styleName?: string
+  text?: string
+}

package/src/types/mline-entity.ts

@@ -0,0 +1,12 @@
+import type { BaseEntity } from './base-entity'
+import type { Point3D } from './common'
+
+export interface MLineEntity extends BaseEntity {
+  type: 'MLINE'
+
+  startPoint?: Point3D
+  endPoint?: Point3D
+
+  vertexCount?: number
+  styleName?: string
+}

package/src/types/oleframe-entity.ts

@@ -0,0 +1,40 @@
+// OLEFrame entity type
+
+import type { BaseEntity } from './base-entity'
+
+/**
+ * OLEFRAME entity
+ * Legacy OLE object frame entity.
+ */
+export interface OleFrameEntity extends BaseEntity {
+  type: 'OLEFRAME'
+
+  /** OLE version number */
+  version?: string | number
+  /** End of object name/description */
+  name?: string | number
+
+  /** Upper-left corner X coordinate (WCS) */
+  upperLeftX?: string | number
+  /** Upper-left corner Y coordinate (WCS) */
+  upperLeftY?: string | number
+  /** Upper-left corner Z coordinate (WCS) */
+  upperLeftZ?: string | number
+
+  /** Lower-right corner X coordinate (WCS) */
+  lowerRightX?: string | number
+  /** Lower-right corner Y coordinate (WCS) */
+  lowerRightY?: string | number
+  /** Lower-right corner Z coordinate (WCS) */
+  lowerRightZ?: string | number
+
+  /** Object type (1=Link, 2=Embedded, 3=Static) */
+  objectType?: string | number
+  /** Tile mode descriptor (0=Model space, 1=Paper space) */
+  tile?: string | number
+
+  /** Length of binary data */
+  length?: string | number
+  /** Binary data (concatenated from multiple 310 codes) */
+  data: string
+}

package/src/types/options.ts

@@ -4,6 +4,13 @@ export interface ToPolylinesOptions {
   interpolationsPerSplineSegment?: number
 }
 
+export interface ToJsonOptions {
+  /** Pretty-print JSON output (defaults to false). */
+  pretty?: boolean
+  /** Indentation spaces when pretty-printing (defaults to 2). */
+  space?: number
+}
+
 /**
  * Viewport percentage controls for DIMENSION autoScale.
  *

package/src/types/ray-entity.ts

@@ -0,0 +1,12 @@
+// RAY entity type
+
+import type { BaseEntity } from './base-entity'
+import type { Point3D } from './common'
+
+export interface RayEntity extends BaseEntity {
+  type: 'RAY'
+  /** Starting point for the ray. */
+  start: Point3D
+  /** Unit direction vector. */
+  direction: Point3D
+}

package/src/types/region-entity.ts

@@ -0,0 +1,11 @@
+import type { BaseEntity } from './base-entity'
+
+export interface RegionEntity extends BaseEntity {
+  type: 'REGION'
+
+  /**
+   * ACIS data payload (text form). This project currently parses and stores it,
+   * but does not attempt to interpret it.
+   */
+  acisData?: string[]
+}

package/src/types/shape-entity.ts

@@ -0,0 +1,19 @@
+// SHAPE entity type
+
+import type { BaseEntity } from './base-entity'
+import type { Point3D } from './common'
+
+export interface ShapeEntity extends BaseEntity {
+  type: 'SHAPE'
+  insertionPoint: Point3D
+  /** Shape name (from a loaded SHX shape file). */
+  name: string
+  /** Size in drawing units. */
+  size: number
+  rotation?: number
+  relativeXScale?: number
+  oblique?: number
+  thickness?: number
+  extrusionX?: number
+  extrusionY?: number
+}

package/src/types/table-entity.ts

@@ -0,0 +1,14 @@
+import type { BaseEntity } from './base-entity'
+
+export interface TableEntity extends BaseEntity {
+  type: 'TABLE'
+
+  rows?: number
+  columns?: number
+
+  /**
+   * Minimal extracted cell text (from group code 1).
+   * This is intentionally lossy; full TABLE semantics are not implemented.
+   */
+  cellText?: string[]
+}

package/src/types/tables.ts

@@ -117,6 +117,54 @@ export interface LayerInternal {
   lineWeightEnum?: string | number
 }
 
+/**
+ * Application ID (APPID) table entry
+ * Minimal internal representation during DXF parsing
+ */
+export interface AppIdInternal {
+  type: string
+  /** Application name */
+  name?: string | number
+  /** Standard flags (bit-coded) */
+  flags?: string | number
+}
+
+/**
+ * Block Record (BLOCK_RECORD) table entry
+ * Minimal internal representation during DXF parsing
+ */
+export interface BlockRecordInternal {
+  type: string
+  /** Block record name */
+  name?: string | number
+  /** Standard flags (bit-coded) */
+  flags?: string | number
+}
+
+/**
+ * User Coordinate System (UCS) table entry
+ * Minimal internal representation during DXF parsing
+ */
+export interface UcsInternal {
+  type: string
+  /** UCS name */
+  name?: string | number
+  /** Standard flags (bit-coded) */
+  flags?: string | number
+}
+
+/**
+ * View (VIEW) table entry
+ * Minimal internal representation during DXF parsing
+ */
+export interface ViewInternal {
+  type: string
+  /** View name */
+  name?: string | number
+  /** Standard flags (bit-coded) */
+  flags?: string | number
+}
+
 /**
  * Text Style (STYLE) table entry
  * Internal representation during DXF parsing
@@ -477,6 +525,28 @@ export interface UnderlayDefinitionObject {
   tuples: DXFTuple[]
 }
 
+export interface DimAssocObject {
+  type: 'DIMASSOC'
+  handle?: string | number
+
+  /** Soft-pointer ID/handle to the owning dictionary (when present). */
+  ownerHandle?: string | number
+
+  /** Raw tuples for downstream consumers (excluding the initial 0/DIMASSOC tuple). */
+  tuples: DXFTuple[]
+}
+
+export interface FieldObject {
+  type: 'FIELD'
+  handle?: string | number
+
+  /** Soft-pointer ID/handle to the owning dictionary (when present). */
+  ownerHandle?: string | number
+
+  /** Raw tuples for downstream consumers (excluding the initial 0/FIELD tuple). */
+  tuples: DXFTuple[]
+}
+
 export interface ParsedObjects {
   /** Layout objects */
   layouts: LayoutInternal[]
@@ -495,4 +565,10 @@ export interface ParsedObjects {
 
   /** UNDERLAYDEFINITION objects keyed by handle */
   underlayDefinitions?: Record<string, UnderlayDefinitionObject>
+
+  /** DIMASSOC objects keyed by handle */
+  dimAssocs?: Record<string, DimAssocObject>
+
+  /** FIELD objects keyed by handle */
+  fields?: Record<string, FieldObject>
 }

package/src/types/trace-entity.ts

@@ -0,0 +1,14 @@
+// TRACE entity type
+
+import type { BaseEntity } from './base-entity'
+import type { Point3D } from './common'
+
+export interface TraceEntity extends BaseEntity {
+  type: 'TRACE'
+
+  /** Four corner points (10/20/30, 11/21/31, 12/22/32, 13/23/33). */
+  corners: Point3D[]
+
+  /** Optional thickness (39). */
+  thickness?: number
+}

package/src/types/wipeout-entity.ts

@@ -0,0 +1,20 @@
+// WIPEOUT entity type
+
+import type { BaseEntity } from './base-entity'
+import type { Point2D, Point3D } from './common'
+
+export interface WipeoutEntity extends BaseEntity {
+  type: 'WIPEOUT'
+
+  insertionPoint: Point3D
+  uVector: Point3D
+  vVector: Point3D
+
+  clipBoundaryType?: 1 | 2
+  clipBoundaryVertices?: Point2D[]
+
+  displayProperties?: number
+  clippingState?: 0 | 1
+  classVersion?: number
+  imageSizePixels?: { u: number; v: number }
+}

package/src/types/xline-entity.ts

@@ -0,0 +1,12 @@
+// XLINE entity type
+
+import type { BaseEntity } from './base-entity'
+import type { Point3D } from './common'
+
+export interface XLineEntity extends BaseEntity {
+  type: 'XLINE'
+  /** Base point for the infinite line. */
+  basePoint: Point3D
+  /** Unit direction vector. */
+  direction: Point3D
+}

package/docs/DIMENSION_SUMMARY.md

@@ -1,254 +0,0 @@
-# DIMENSION Implementation Summary
-
-## Overview
-
-The `DIMENSION` entity is implemented with support for the `DIMSTYLE` system, including parsing, storage, and SVG rendering.
-
-SVG rendering supports DXF dimension types 0/1/2/3/4/5/6.
-
-## Implementation Status
-
-### ✅ Phase 1: DIMSTYLE Parsing and Storage (100%)
-
-* **DIMSTYLE Handler**: `src/handlers/tables.ts`
-  * 68+ properties parsed via group codes
-  * Main properties: DIMASZ (41), DIMTXT (140), DIMEXO (176), DIMEXE (177)
-  * Colors: DIMCLRD (176), DIMCLRE (177), DIMCLRT (178)
-  * Line weights: DIMLWD (371), DIMLWE (372)
-  * Arrow blocks: DIMBLK (342), DIMBLK1 (343), DIMBLK2 (344)
-  * Tolerances: DIMTOL (71), DIMTOLJ (283)
-  * Alternate units: DIMALT (170), DIMALTF (143), DIMALTD (171)
-
-* **TypeScript Interfaces**:
-  * `DimStyleInternal` in `src/types/tables.ts` (internal storage)
-  * `DimStyleTable` in `src/types/dxf.ts` (public API)
-
-* **Integration**:
-  * DIMSTYLE stored in `parsed.tables.dimStyles`
-  * DIMENSION entity linked to style via `styleName`
-
-### ✅ Phase 2: Modular Architecture (100%)
-
-* **Dedicated Module**: `src/dimensionToSVG.ts` (428 lines)
-  * Dispatcher based on `entity.dimensionType`
-  * 6 specialized rendering functions
-  * SVG marker system for arrows
-  * Helper functions for colors and geometry
-
-* **Main Functions**:
-  * `dimensionToSVG()`: Main dispatcher
-  * `createArrowMarker()`: SVG marker creation with unique IDs
-  * `colorNumberToSVG()`: DXF color conversion (0-255) to RGB
-  * `getDimensionColors()`: Color extraction from DIMSTYLE
-
-* **Integration with toSVG.ts**:
-  * `dimension()` calls `dimensionToSVG()` with correct DIMSTYLE
-  * Apply transforms to dimensions
-
-### ✅ Phase 3: Advanced Rendering (100%)
-
-Dimension types implemented with precise geometry:
-
-#### 1. Linear Dimension (types 0 and 1)
-
-* Extension lines with offset (DIMEXO) and extension (DIMEXE)
-* Perpendicular geometry calculation (angle + π/2)
-* Dimension line with arrows at ends
-* Rotated text aligned to dimension
-* File: `renderLinearDimension()`
-
-#### 2. Angular Dimension (type 2)
-
-* Radial extension lines from center
-* Dimension line as SVG arc
-* Large-arc flag calculation for arcs > 180°
-* Arrows at arc ends
-* Text rotated at mid-angle
-* File: `renderAngularDimension()`
-
-#### 3. Diameter Dimension (type 3)
-
-* Line through circle
-* Symbol ⌀ (Unicode U+2300) in text
-* Single arrow at end
-* File: `renderDiameterDimension()`
-
-#### 4. Radius Dimension (type 4)
-
-* Line from center to circumference
-* Prefix "R" in text
-* Single arrow at end
-* File: `renderRadialDimension()`
-
-#### 5. Ordinate Dimension (type 6)
-
-* Simple leader line
-* No arrows (per DXF specification)
-* Text with X or Y coordinate
-* File: `renderOrdinateDimension()`
-
-#### 6. Fallback
-
-* Minimal rendering for unsupported types
-* Text only at textMidpoint position
-* File: `renderFallbackDimension()`
-
-
-
-### ✅ Phase 4: Colors and Refinements (100%)
-
-#### DIMSTYLE Colors (100%)
-
-* **DIMCLRD**: Dimension line color
-* **DIMCLRE**: Extension line color
-* **DIMCLRT**: Text color
-* **DIMLWD**: Dimension line weight
-* **DIMLWE**: Extension line weight
-
-Implementation:
-
-* DXF color table: `src/util/colors.ts` (267 colors)
-* DXF → RGB conversion: `colorNumberToSVG()`
-* Special cases: 0 (ByBlock), 256 (ByLayer), 7 (white/black) → currentColor
-* Applied in all rendering functions
-* Arrow markers inherit dimension line color
-
-#### Optional Features (Not Implemented)
-
-##### Custom Arrow Blocks (⏸️ Low Priority)
-
-* DIMBLK, DIMBLK1, DIMBLK2 parsed and available
-* Requires complex integration with INSERT renderer
-* Fallback to standard triangular arrows works in most cases
-
-
-##### Tolerances and Alternate Units (⏸️ Low Priority)
-
-* DIMTOL, DIMALT and related properties parsed
-* Requires complex multi-line text formatting
-* Simple text sufficient for most cases
-
-
-##### XDATA Overrides (⏸️ Rare Edge Case)
-
-* Per-entity DIMSTYLE property overrides via XDATA
-* Not implemented
-* Default DIMSTYLE works in most cases
-
-## Modified Files
-
-### Created
-
-* `src/dimensionToSVG.ts`: Complete rendering module (428 lines)
-* `docs/DIMENSION_IMPLEMENTATION_PLAN.md`: Detailed implementation plan
-* `docs/DIMENSION_SUMMARY.md`: This file
-
-### Modified
-
-* `src/handlers/entity/dimension.ts`: Added text (1) and styleName (3) parsing
-* `src/types/dimension-entity.ts`: Added text and styleName properties
-* `src/handlers/tables.ts`: Complete DIMSTYLE handler (68 properties)
-* `src/types/tables.ts`: DimStyleInternal interface
-* `src/types/dxf.ts`: DimStyleTable interface (public API)
-* `src/toSVG.ts`: Integration with dimensionToSVG, pass dimStyles
-* `docs/IMPLEMENTED-2D-ENTITIES.md`: Updated DIMENSION entry
-
-## Commits
-
-### Commit 1: Phases 1 and 2
-
-```text
-feat: add complete DIMSTYLE parsing and modular architecture for DIMENSION
-
-Phase 1: DIMSTYLE Parsing and Storage
-- Create complete DIMSTYLE handler with 68+ properties
-- Process group codes: DIMASZ (41), DIMTXT (140), DIMEXO (176), DIMEXE (177), etc.
-- Add DimStyleInternal and DimStyleTable interfaces
-- Integrate dimStyles into parsed.tables
-- Link DIMENSION entities to their DIMSTYLE via styleName
-
-Phase 2: Modular Rendering Architecture
-- Create dedicated module src/dimensionToSVG.ts
-- Implement dispatcher based on dimensionType
-- Create 6 specialized rendering functions
-- Add createArrowMarker for SVG markers
-- Integrate dimensionToSVG with toSVG.ts
-```
-
-9 files modified, 874 insertions(+), 10 deletions(-)
-
-### Commit 2: Phase 3
-
-```text
-feat: implement advanced dimension rendering with extension lines and arrows
-
-Phase 3: Advanced Rendering
-- Implement extension lines with DIMEXO (offset) and DIMEXE (extension)
-- Add perpendicular geometry calculation for extension lines
-- Create SVG markers for arrows with unique IDs (timestamp-based)
-- Implement text rotation aligned to dimension
-- Add angular dimensions with SVG arcs
-- Implement ⌀ and R symbols for diameter/radius
-- Support ordinate dimensions without arrows
-- Apply configurable line weights
-```
-
-2 files modified, 145 insertions(+), 30 deletions(-)
-
-### Commit 3: Phase 4 (This Commit)
-
-```text
-feat: add complete DIMSTYLE color support and documentation
-
-Phase 4: Colors and Refinements
-- Add colorNumberToSVG function for DXF → RGB conversion
-- Implement getDimensionColors to extract colors from DIMSTYLE
-- Apply DIMCLRD (dimension line color) in all renderings
-- Apply DIMCLRE (extension line color) in all renderings
-- Apply DIMCLRT (text color) in all renderings
-- Apply DIMLWD and DIMLWE (line weights) to lines
-- Add dimBlk, dimBlk1, dimBlk2 properties to DimStyleTable
-- Update implementation plan with complete status
-- Update entity documentation with detailed implementation
-- Create complete implementation summary
-```
-
-## Testing and Validation
-
-### Build
-
-* ✅ ESM Build: 21-24ms
-* ✅ CJS Build: 18-19ms
-* ✅ 0 TypeScript errors
-* ⚠️ 1 warning (import.meta in es2015 - unrelated)
-
-### Generated Files
-
-* `lib/dimensionToSVG.js`: 14.6kb (ESM)
-* `lib/dimensionToSVG.cjs`: 16.4kb (CJS)
-* `lib/handlers/tables.js`: 15.3kb (ESM)
-* `lib/handlers/tables.cjs`: 16.8kb (CJS)
-
-### Feature Coverage
-
-* ✅ Parsing: 100% (68 DIMSTYLE properties)
-* ✅ Basic rendering: 100% (6 dimension types)
-* ✅ Advanced rendering: 100% (extension lines, arrows, rotation)
-* ✅ Colors: 100% (DIMCLRD, DIMCLRE, DIMCLRT)
-* ⏸️ Custom arrows: 0% (optional, low priority)
-* ⏸️ Tolerances: 0% (optional, low priority)
-* ⏸️ XDATA overrides: 0% (optional, edge case)
-
-## Next Steps (Optional)
-
-1. **Unit tests**: Create tests for each dimension type
-2. **Integration tests**: Validate with real DXF files
-3. **Custom arrow blocks**: Implement if there is demand
-4. **Tolerances**: Implement if there is demand
-5. **Performance**: Profiling and optimization if necessary
-
-## Conclusion
-
-The `DIMENSION` implementation is complete for common use cases (estimate: 95% of DXF files). The optional features not implemented are rare edge cases or too complex for the limited benefit they would provide.
-
-The modular architecture allows for easy future extension if needed.

package/docs/DXF_VERSION_SUPPORT.md

@@ -1,45 +0,0 @@
-# DXF Version Support
-
-## Current Position
-
-The parser is designed around DXF group codes and sections, and does not currently gate behavior on `$ACADVER`.
-
-In practice, this means:
-
-- We aim to **parse and render** supported entities across many DXF versions.
-- We treat `$ACADVER` primarily as a fixture metadata signal and future compatibility hook.
-
-## What “Latest AutoCAD DXF” Means Here
-
-AutoCAD introduces newer DXF versions over time (reflected in `$ACADVER`). Supporting “the latest” is best defined as:
-
-- The library can load DXF files produced by recent AutoCAD versions **without rejecting due to version**, and
-- The library has fixtures that include a recent `$ACADVER` value, validated by ezdxf.
-
-## Recommended Strategy
-
-1. **Track `$ACADVER` in fixture validation**
-   - Use `yarn validate:fixtures` to report `$ACADVER` for every fixture.
-
-2. **Add at least one fixture exported from a recent AutoCAD version**
-   - Keep it small and single-purpose.
-   - Prefer a fixture that includes DIMENSION + text (to exercise newer text encoding and styles).
-
-3. **Add an integration test for that fixture**
-   - The goal is “does not throw + expected key SVG features exist”.
-
-4. **Add a policy (doc + CI)**
-   - Document which `$ACADVER` values are present in fixtures.
-   - Optionally enforce a minimum accepted `$ACADVER` in fixtures if the project wants to keep up with AutoCAD releases.
-
-## Non-Goals
-
-- Guarantee support for every new entity introduced by new DXF versions.
-- Guarantee binary DXF support (unless explicitly added).
-
-## Follow-ups (If Needed)
-
-If we need version-specific behavior later, add:
-
-- A header helper that exposes `$ACADVER` in a typed way.
-- Tests that cover version-specific parsing/rendering differences.