@linkiez/dxf-renew 7.1.0 → 7.2.0

package/docs/ENTITY_SVG_ROADMAP.md

@@ -1,96 +0,0 @@
-# Entity SVG Roadmap (Fixture → ezdxf → SVG Integration)
-
-This roadmap is a **repeatable checklist** for each DXF entity:
-
-1. Confirm/produce a fixture in `test/resources/`
-2. Validate it with ezdxf
-3. Add/extend unit parsing tests
-4. Add final SVG integration tests
-
-The goal is incremental coverage: one entity at a time, with fixtures and tests proving end-to-end behavior.
-
-## Template (Use For Every Entity)
-
-### 1) Fixture
-
-- Add or pick a DXF fixture in `test/resources/<entity>-<scenario>.dxf`.
-- Keep fixtures minimal: only the needed sections/entities.
-
-### 2) ezdxf validation
-
-- Run `yarn validate:fixtures`
-- Confirm:
-  - The file loads in ezdxf
-  - `$ACADVER` is present and sane
-  - Entity type counts include your target entity
-
-### 3) Unit tests
-
-- Add unit parsing tests under `test/unit/`.
-- Assert minimum required fields for the entity type.
-
-### 4) SVG integration tests
-
-- Add `test/integration-browser/<entity>-rendering.browser.spec.js`.
-- Assert:
-  - `<svg ...>` envelope
-  - `viewBox="..."`
-  - Required SVG elements exist
-  - Key attributes exist (markers, transforms, href, etc)
-  - Expected text content (when applicable)
-
-#### Saved PNG per entity (required)
-
-Every browser integration test should save a screenshot to `test/rendered/` for manual review.
-
-- Use deterministic naming tied to the fixture: `test/rendered/<fixture-name>.png`
-- Overwrite is expected (re-running tests updates the same file).
-
-See: `docs/SVG_RENDERING_INTEGRATION_TESTS.md` (Saved Render Artifacts section)
-
-## DIMENSION (Start Here)
-
-### Fixture(s)
-
-- `test/resources/dimension-vertical.dxf`
-- `test/resources/dimensions.dxf` (optional secondary)
-
-### ezdxf validation
-
-- Run `yarn validate:fixtures`
-- Confirm `dimension-vertical.dxf` includes `DIMENSION` in modelspace.
-
-### Unit tests
-
-Already present:
-
-- `test/unit/dimensions.test.js`
-
-### SVG integration test
-
-Implemented:
-
-- `test/integration-browser/dimension-rendering.browser.spec.js`
-
-Assertions:
-
-- Marker definitions exist (prefix-based regex)
-- Dimension line references `marker-start` and `marker-end`
-- Dimension text appears in the SVG (`5.35`)
-
-## Next Entities (Suggested Order)
-
-This order prioritizes entities already in the codebase and/or those that tend to break rendering pipelines.
-
-1. TEXT
-2. MTEXT
-3. LEADER
-4. TOLERANCE
-5. IMAGE / IMAGEDEF
-6. UNDERLAY (DWF/DGN/PDF underlay entities)
-7. INSERT (block expansion)
-8. HATCH
-9. LWPOLYLINE / POLYLINE
-10. SPLINE
-
-For each, create at least one “single entity” fixture and one “mixed scene” fixture.

package/docs/IMPLEMENTED-2D-ENTITIES.md

@@ -1,54 +0,0 @@
-# List of DXF 2D Entities
-
-This list was generated based on the AutoCAD 2012 DXF reference documentation. It catalogs 2D entities, indicating whether they have already been implemented in this project.
-
-| Entity | Implemented | Description |
-| :--- | :---: | :--- |
-| **ARC** | ✅ | A circular arc. |
-| **CIRCLE** | ✅ | A circle. |
-| **ELLIPSE** | ✅ | An ellipse or elliptical arc. |
-| **HATCH** | ✅ | Fills a bounded area with a pattern, solid color, or gradient. |
-| **LINE** | ✅ | A straight line segment. |
-| **LWPOLYLINE** | ✅ | A lightweight 2D polyline. |
-| **MTEXT** | ✅ | Multi-line text with advanced formatting. |
-| **POINT** | ✅ | A point entity. |
-| **POLYLINE** | ✅ | A 2D or 3D polyline (with vertices). |
-| **SOLID** | ✅ | A 2D area filled with solid color. |
-| **SPLINE** | ✅ | A spline curve. |
-| **TEXT** | ✅ | A single line of text. |
-| **DIMENSION** | ✅ | Dimension entity (linear, angular, radial, etc.). **Complete implementation**: text and styleName parsing, DIMSTYLE integration (68+ properties), rendering of 6 dimension types with extension lines, arrows, text rotation, color support (DIMCLRD, DIMCLRE, DIMCLRT) and line weights (DIMLWD, DIMLWE). See `docs/DIMENSION_IMPLEMENTATION_PLAN.md` for details. |
-| **INSERT** | ✅ | A block insertion (block reference). |
-| **ATTDEF** | ✅ | Attribute definition for a block. |
-| **ATTRIB** | ✅ | An attribute instance attached to a block. |
-| **OLE2FRAME** | ✅ | An OLE (Object Linking and Embedding) object. |
-| **LEADER** | ❌ | A leader line, used for annotations. Creates a line that connects the annotation to a feature in a drawing. |
-| **MLINE** | ❌ | A multi-line entity with parallel lines. |
-| **RAY** | ❌ | A semi-infinite line that extends infinitely in one direction from its start point. |
-| **SHAPE** | ❌ | A shape from a shape file (.shx). Inserts a named shape from a shape file that has already been loaded using the LOAD command. |
-| **TOLERANCE** | ❌ | A geometric tolerance. Creates geometric tolerances contained in a feature control frame. |
-| **TRACE** | ❌ | A solid 2D line with width. |
-| **WIPEOUT** | ❌ | An area that masks other objects with the background color. |
-| **XLINE** | ❌ | An infinite construction line. |
-
----
-
-## 3D Entities (For Reference)
-
-| Entity | Implemented | Description |
-| :--- | :---: | :--- |
-| **3DFACE** | ✅ | A three-dimensional face. |
-| **3DSOLID** | ❌ | A 3D ACIS solid object. Displays 3D solids as wireframe or shaded objects. |
-| **BODY** | ❌ | A 3D ACIS body object. |
-| **HELIX** | ❌ | A 3D helix. |
-| **IMAGE** | ❌ | A raster image. |
-| **LIGHT** | ❌ | A light source. |
-| **MESH** | ❌ | A 3D mesh. |
-| **REGION** | ❌ | A closed 2D area (region). |
-| **SECTION** | ❌ | A section object. |
-| **SUN** | ❌ | A sun light object. |
-| **SURFACE** | ❌ | A 3D surface (extruded, loft, etc.). |
-| **TABLE** | ❌ | A table entity. |
-| **UNDERLAY** | ❌ | An underlay (e.g., DWF, DGN, PDF). |
-| **VIEWPORT** | ✅ | A viewport in paper space. |
-
-*Note: The `POLYLINE` implementation may include 3D vertices, but the entity itself is often used for 2D shapes.*

package/docs/README.md

@@ -1,22 +0,0 @@
-# Documentation
-
-This folder contains the project documentation. The goal is to keep docs small, focused, and non-overlapping.
-
-## Where to Start
-
-- Entity support overview: `docs/IMPLEMENTED-2D-ENTITIES.md`
-- DXF version support notes: `docs/DXF_VERSION_SUPPORT.md`
-- TEXT / MTEXT / DIMENSION notes: `docs/TEXT-MTEXT-DIMENSION-SUPPORT.md`
-- DIMENSION summary (implementation-specific): `docs/DIMENSION_SUMMARY.md`
-
-## Testing & Fixtures
-
-- End-to-end SVG tests (Playwright): `docs/SVG_RENDERING_INTEGRATION_TESTS.md`
-- Fixture validation via ezdxf: `docs/FIXTURE_VALIDATION_EZDXF.md`
-- Entity-by-entity workflow (fixture → ezdxf → tests): `docs/ENTITY_SVG_ROADMAP.md`
-
-## References
-
-- ezdxf reference sitemap for this repo: `docs/EZDXF_REFERENCE_SITEMAP.md`
-
-Note: `docs/autocad_2012_pdf_dxf-reference_enu.md` is a local reference copy and is not part of the maintained documentation flow.

package/docs/SVG_RENDERING_INTEGRATION_TESTS.md

@@ -1,119 +0,0 @@
-# SVG Rendering Integration Tests
-
-## Goal
-
-Add end-to-end tests that validate the **final SVG output** for real DXF fixtures:
-
-`DXF fixture → parseString() → (optional denormalise) → toSVG() → SVG assertions`
-
-The project already has strong unit tests for geometry and parsing. This document defines a predictable integration-test layer to catch regressions at the “final render” boundary.
-
-## Framework Choice
-
-Run the final rendering integration tests in a **real browser** using **Playwright**.
-
-Rationale:
-
-- Executes the same rendering code path in a browser runtime.
-- Enables future pixel/screenshot tests (if ever needed) without changing frameworks.
-- Still supports stable structural assertions (regex/DOM parsing) for deterministic checks.
-
-## Where Tests Live
-
-- Integration tests: `test/integration/**`
-- Browser integration tests: `test/integration-browser/**`
-- DXF fixtures: `test/resources/*.dxf`
-
-Browser harness:
-
-- `test/browser/harness.html`
-- Served by `tools/browser_test_server.cjs`
-
-Scripts:
-
-- `yarn test:integration` (browser, via Playwright)
-- `yarn test:integration:node` (legacy Node-only integration tests)
-
-## What Integration Tests Should Assert
-
-Integration tests should focus on **stable, user-visible output** and avoid overfitting internal implementation details.
-
-Recommended assertions (in order):
-
-1. **SVG well-formed envelope**
-   - Contains `<svg` and `</svg>`
-   - Includes `viewBox="..."`
-
-2. **Entity-specific rendering markers**
-   - Presence of SVG elements expected for the entity type (`<line>`, `<path>`, `<circle>`, `<text>`, `<image>`)
-
-3. **Critical attributes**
-   - For example: `marker-start/marker-end` for DIMENSION arrows
-   - For example: correct path command type for ARC (`A`) or SPLINE (`C/Q`)
-
-4. **Text content (when applicable)**
-   - Assert the final SVG contains the expected text payload
-
-5. **No crashes on full fixture set**
-   - A single integration test can iterate a curated list of fixtures and ensure rendering does not throw.
-
-### Saved Render Artifacts (PNG)
-
-Browser integration tests should save a screenshot under `test/rendered/` for manual review.
-
-- The file can be overwritten on re-run.
-- Prefer a deterministic filename tied to the fixture name, e.g. `test/rendered/dimension-vertical.png`.
-
-Note: these PNGs are tracked in git. If you regenerate them, include the updated files in your PR.
-
-### Handling Non-Deterministic IDs
-
-Some renderers generate IDs using `Date.now()` (e.g. DIMENSION arrow markers). Integration tests should validate **prefix-based patterns**:
-
-- `dim-arrow-start-\d+`
-- `dim-arrow-end-\d+`
-
-Avoid asserting the full exact ID.
-
-## Golden Files (Optional)
-
-If/when the project wants pixel-perfect or full-SVG snapshots, consider adding a “golden SVG” snapshot layer.
-
-Guidelines:
-
-- Only snapshot **small, stable fixtures**.
-- Normalize dynamic values (e.g. marker IDs) before snapshotting.
-- Keep snapshots per-fixture under `test/snapshots/`.
-
-This is intentionally optional; regex-based structural assertions are the default.
-
-## DIMENSION: First Integration Target
-
-Start with fixtures that include real DIMENSION output:
-
-- `test/resources/dimension-vertical.dxf`
-
-Suggested assertions:
-
-- Markers exist (`<marker id="dim-arrow-start-..."`)
-- Dimension line uses `marker-start/marker-end`
-- Text appears in SVG (fixture includes `5.35`)
-
-See:
-
-- `test/integration-browser/dimension-rendering.browser.spec.js`
-
-## Adding a New Integration Test (Checklist)
-
-1. Pick or create a DXF fixture under `test/resources/`.
-2. (Recommended) Validate it with `yarn validate:fixtures` (see `docs/FIXTURE_VALIDATION_EZDXF.md`).
-3. Add a new `test/integration/*.integration.test.js`.
-   - Or, for browser execution, add `test/integration-browser/*.browser.spec.js`.
-4. Assert:
-   - SVG envelope + viewBox
-   - Entity-specific elements
-   - Critical attributes
-   - Screenshot is saved to `test/rendered/<fixture-name>.png` (overwrite on re-run)
-5. Run:
-   - `yarn test:unit`
-   - `yarn test:integration`

package/docs/TEXT-MTEXT-DIMENSION-SUPPORT.md

@@ -1,241 +0,0 @@
-# TEXT, MTEXT and DIMENSION - SVG Rendering Support# TEXT, MTEXT e DIMENSION - Suporte de Renderização SVG
-
-## Summary of Changes## Resumo das Mudanças
-
-Added complete support for rendering TEXT, MTEXT, and DIMENSION entities in SVG.Adicionado suporte completo para renderização de entidades TEXT, MTEXT e DIMENSION em SVG.
-
-## Supported Entities## Entidades Suportadas
-
-### TEXT### TEXT
-
-- Basic text rendering- Renderização básica de texto
-
-- Rotation support (code 50)- Suporte para rotação (código 50)
-
-- Positioning support (codes 10, 20, 30)- Suporte para posicionamento (códigos 10, 20, 30)
-
-- Text height support (code 40)- Suporte para altura do texto (código 40)
-
-- Horizontal and vertical alignment (codes 72, 73)- Alinhamento horizontal e vertical (códigos 72, 73)
-
-### MTEXT### MTEXT
-
-- Multi-line text rendering- Renderização de texto multilinha
-
-- Rotation support via X-axis direction (codes 11, 21)- Suporte para rotação via direção do eixo X (códigos 11, 21)
-
-- Reference rectangle width support (code 41)- Suporte para largura do retângulo de referência (código 41)
-
-- Nominal text height (code 40)- Altura nominal do texto (código 40)
-
-- Attachment point (code 71)- Ponto de fixação (código 71)
-
-### DIMENSION### DIMENSION
-
-Support for all dimension types:Suporte para todos os tipos de dimensão:
-
-#### Type 0 - Rotated, horizontal or vertical#### Tipo 0 - Rotated, horizontal ou vertical
-
-- Extension lines- Linhas de extensão
-
-- Dimension line- Linha de dimensão
-
-- Dimension text- Texto de dimensão
-
-#### Type 1 - Aligned#### Tipo 1 - Aligned (alinhada)
-
-- Dimension line aligned with measured points- Linha de dimensão alinhada com os pontos medidos
-
-- Perpendicular extension lines- Linhas de extensão perpendiculares
-
-#### Type 2 - Angular#### Tipo 2 - Angular (angular)
-
-- Angle dimension between two lines- Dimensão de ângulo entre duas linhas
-
-#### Type 3 - Diameter#### Tipo 3 - Diameter (diâmetro)
-
-- Radial dimension line for diameters- Linha de dimensão radial para diâmetros
-
-- Text with diameter symbol- Texto com símbolo de diâmetro
-
-#### Type 4 - Radius#### Tipo 4 - Radius (raio)
-
-- Radial dimension line- Linha de dimensão radial
-
-- Text with R prefix- Texto com prefixo R
-
-#### Type 5 - Angular 3 point#### Tipo 5 - Angular 3 point (angular 3 pontos)
-
-- Angular dimension defined by 3 points- Dimensão angular definida por 3 pontos
-
-#### Type 6 - Ordinate#### Tipo 6 - Ordinate (ordenada)
-
-- X or Y coordinate dimension- Dimensão de coordenada X ou Y
-
-- Simple extension line- Linha de extensão simples
-
-## Implemented DXF Codes## Códigos DXF Implementados
-
-### TEXT
-
-| Code | Description || Código | Descrição |
-
-|------|-------------||--------|-----------|
-
-| 1 | Text content || 1 | Conteúdo do texto |
-
-| 10, 20, 30 | Insertion point (x, y, z) || 10, 20, 30 | Ponto de inserção (x, y, z) |
-
-| 11, 21, 31 | Second alignment point || 11, 21, 31 | Segundo ponto de alinhamento |
-
-| 40 | Text height || 40 | Altura do texto |
-
-| 41 | Relative X scale || 41 | Escala relativa X |
-
-| 50 | Rotation in degrees || 50 | Rotação em graus |
-
-| 51 | Oblique angle || 51 | Ângulo oblíquo |
-
-| 72 | Horizontal alignment || 72 | Alinhamento horizontal |
-
-| 73 | Vertical alignment || 73 | Alinhamento vertical |
-
-### MTEXT### MTEXT
-
-| Code | Description || Código | Descrição |
-
-|------|-------------||--------|-----------|
-
-| 1, 3 | Text content || 1, 3 | Conteúdo do texto |
-
-| 10, 20, 30 | Insertion point || 10, 20, 30 | Ponto de inserção |
-
-| 11, 21, 31 | X-axis direction || 11, 21, 31 | Direção do eixo X |
-
-| 40 | Nominal text height || 40 | Altura nominal do texto |
-
-| 41 | Reference rectangle width || 41 | Largura do retângulo de referência |
-
-| 71 | Attachment point || 71 | Ponto de fixação |
-
-| 72 | Drawing direction || 72 | Direção do desenho |
-
-### DIMENSION### DIMENSION
-
-| Code | Description || Código | Descrição |
-
-|------|-------------||--------|-----------|
-
-| 2 | Block name || 2 | Nome do bloco |
-
-| 10, 20, 30 | Definition point || 10, 20, 30 | Ponto de definição |
-
-| 11, 21, 31 | Text midpoint || 11, 21, 31 | Ponto médio do texto |
-
-| 13, 23, 33 | Measurement start point || 13, 23, 33 | Ponto inicial da medida |
-
-| 14, 24, 34 | Measurement end point || 14, 24, 34 | Ponto final da medida |
-
-| 50 | Rotation angle || 50 | Ângulo de rotação |
-
-| 70 | Dimension type || 70 | Tipo de dimensão |
-
-## Usage Example## Exemplo de Uso
-
-```javascript```javascript
-
-import { Helper } from '@linkiez/dxf-renew'
-
-const dxfString = `... DXF content ...`const dxfString = `... conteúdo DXF ...`
-
-const helper = new Helper(dxfString)const helper = new Helper(dxfString)
-
-// Convert to SVG (now includes TEXT, MTEXT and DIMENSION)// Converter para SVG (agora inclui TEXT, MTEXT e DIMENSION)
-
-const svg = helper.toSVG()const svg = helper.toSVG()
-
-```
-
-
-
-## Tests## Testes
-
-
-
-Unit tests have been added in `test/unit/text-mtext-dimension-rendering.js` that verify:Foram adicionados testes unitários em `test/unit/text-mtext-dimension-rendering.js` que verificam:
-
-
-
-- Basic TEXT rendering- Renderização básica de TEXT
-
-- Basic MTEXT rendering- Renderização básica de MTEXT
-
-- DIMENSION rendering- Renderização de DIMENSION
-
-- TEXT rotation- Rotação de TEXT
-
-- MTEXT rotation via X-axis direction- Rotação de MTEXT via direção do eixo X
-
-- Different DIMENSION types- Diferentes tipos de DIMENSION
-
-
-
-Run tests with:Execute os testes com:
-
-
-
-```bash```bash
-
-npm testnpm test
-
-``````
-
-## Visual Example## Exemplo Visual
-
-An interactive visual example is available at `examples/text-dimension-viewer.html`.Um exemplo visual interativo está disponível em `examples/text-dimension-viewer.html`.
-
-To view:Para visualizar:
-
-1. Run `npm run build` to generate the bundle1. Execute `npm run build` para gerar o bundle
-
-2. Open `examples/text-dimension-viewer.html` in a browser2. Abra `examples/text-dimension-viewer.html` em um navegador
-
-3. Load a DXF file or use the provided test files3. Carregue um arquivo DXF ou use os arquivos de teste fornecidos
-
-## Known Limitations## Limitações Conhecidas
-
-1. **TEXT and MTEXT**:1. **TEXT e MTEXT**:
-
-   - Font is not respected (uses browser default font)   - Fonte não é respeitada (usa fonte padrão do navegador)
-
-   - Complex MTEXT formatting is not fully supported   - Formatação complexa de MTEXT não é totalmente suportada
-
-   - Bounding box calculation is approximate   - Cálculo de bounding box é aproximado
-
-2. **DIMENSION**:2. **DIMENSION**:
-
-   - Custom dimension blocks are not rendered   - Blocos de dimensão personalizados não são renderizados
-
-   - Only basic dimension lines are drawn   - Apenas linhas básicas de dimensão são desenhadas
-
-   - Dimension text is not displayed (needs to be extracted from block)   - Texto de dimensão não é exibido (precisa ser extraído do bloco)
-
-   - Arrows are not rendered   - Setas não são renderizadas
-
-## Modified Files## Arquivos Modificados
-
-- `src/toSVG.js`: Added `text()`, `mtext()`, `dimension()` and `createDimensionPaths()` functions- `src/toSVG.js`: Adicionadas funções `text()`, `mtext()`, `dimension()` e `createDimensionPaths()`
-
-- `test/unit/text-mtext-dimension-rendering.js`: New unit tests- `test/unit/text-mtext-dimension-rendering.js`: Novos testes unitários
-
-- `examples/text-dimension-viewer.html`: Interactive visual example
-
-## Next Steps
-
-To further improve support:
-
-1. Implement dimension arrow rendering
-2. Extract and render dimension text from blocks
-3. Support custom text styles
-4. Improve bounding box calculation for text
-5. Support advanced MTEXT formatting (colors, bold, etc.)