feat(data-model): OLE2FRAME geometry, ByBlock=ACI7, and native DXF default registration (#160)

Author: mlightcad

.gitignore

@@ -7,9 +7,8 @@ lib
 tmp
 tsconfig.tsbuildinfo
 
-# mlightcad private parser and converter packages
-mlightcad-parser
-mlightcad-converter
+# Private package — clone locally; never commit
+packages/dwg-converter
 
 # dependencies
 node_modules

README.md

@@ -22,14 +22,16 @@ To support reading both DXF and DWG files (and potentially other formats in the
 
 - Each file type (e.g., DXF, DWG) is associated with a converter class that knows how to parse and import that file format into the drawing database.
 - The `AcDbDatabaseConverterManager` maintains a registry of these converters, allowing you to register or unregister converters for specific file types at runtime.
-- **DXF is registered by default.** Importing `@mlightcad/data-model` registers the built-in MIT `AcDbNativeDxfConverter`. You only need to register a DXF converter if you want to replace that default (for example with `@mlightcad/dxf-json-converter`).
+- **DXF is registered by default.** `AcDbDatabaseConverterManager` registers the built-in MIT `AcDbNativeDxfConverter` when the singleton is created. You only need to register a DXF converter if you want to replace that default.
 - **DWG is not registered by default.** Register a DWG converter (typically `@mlightcad/libredwg-converter`) before calling `AcDbDatabase.read()` on DWG files.
 
-`@mlightcad/dxf-json-converter` and `@mlightcad/libredwg-converter` are designed to run their parsers in a Web Worker. That is a deliberate licensing choice: their upstream parsers are copyleft (GPL/LGPL), so keeping them in a separate worker bundle helps isolate that code from the main application. The built-in `AcDbNativeDxfConverter` does **not** need a worker — it is MIT-licensed and runs on the main thread.
+`@mlightcad/libredwg-converter` runs its LibreDWG parser in a Web Worker. That is a deliberate licensing choice: the upstream parser is copyleft (GPL), so keeping it in a separate worker bundle helps isolate that code from the main application. The built-in `AcDbNativeDxfConverter` does **not** need a worker — it is MIT-licensed and runs on the main thread.
+
+Deprecated GPL converters (`@mlightcad/dxf-json-converter`, `@mlightcad/libdxfrw-converter`) have moved to the separate [dwg-dxf-converter](https://github.com/mlightcad/dwg-dxf-converter) repository and are no longer documented here.
 
 ### Registering Converters
 
-DXF works out of the box. Register a DWG converter before reading DWG files. Optionally replace the default DXF converter:
+DXF works out of the box. Register a DWG converter before reading DWG files:
 
 ```ts
 import {
@@ -38,15 +40,6 @@ import {
 } from '@mlightcad/data-model'
 import { AcDbLibreDwgConverter } from '@mlightcad/libredwg-converter'
 
-// Optional: replace the default MIT AcDbNativeDxfConverter with the GPL worker-based parser
-// import { AcDbDxfConverter } from '@mlightcad/dxf-json-converter'
-// const dxfConverter = new AcDbDxfConverter({
-//   convertByEntityType: false,
-//   useWorker: true,
-//   parserWorkerUrl: './assets/dxf-parser-worker.js'
-// })
-// AcDbDatabaseConverterManager.instance.register(AcDbFileType.DXF, dxfConverter)
-
 // DWG converter (copyleft parser is loaded in a separate Web Worker for license isolation)
 const dwgConverter = new AcDbLibreDwgConverter({
   convertByEntityType: false,
@@ -59,7 +52,7 @@ AcDbDatabaseConverterManager.instance.register(
 )
 ```
 
-Deploy `libredwg-parser-worker.js` (and `dxf-parser-worker.js` only if you use `dxf-json-converter`) from each converter package's `dist/` folder to a public URL (see [example vite config](./packages/example/vite.config.ts)).
+Deploy `libredwg-parser-worker.js` from `@mlightcad/libredwg-converter`'s `dist/` folder to a public URL (see [example vite config](./packages/example/vite.config.ts)).
 
 ### Unregistering a Converter
 
@@ -127,30 +120,17 @@ This design ensures the system is open for extension and can easily adapt to new
 
 AutoCAD holds an absolute dominant position in the 2D CAD field. A large number of vertical applications and third-party plugins have been developed based on AutoCAD ObjectARX, and there are many software engineers familiar with AutoCAD ObjectARX. Therefore, this project mimics the architecture of AutoCAD ObjectARX and adopts similar API interfaces to AutoCAD ObjectARX.
 
-### libdxfrw-converter (DWG file support)
-
-DWG support via libdxfrw lives in the separate [dwg-dxf-converter](https://github.com/mlightcad/dwg-dxf-converter) monorepo (`@mlightcad/libdxfrw-converter`). It is powered by libdxfrw compiled to WebAssembly. Note: this converter does **not** provide worker isolation — GPL libdxfrw code runs on the main thread.
-
 ### libredwg-converter (DWG file support)
 
 This module provides a DWG file converter for the RealDWG-Web ecosystem, enabling reading and conversion of DWG files into the drawing database. It is powered by the LibreDWG library compiled to WebAssembly and is designed to be registered with the converter manager for DWG file support.
 
 DWG parsing is provided through a dedicated Web Worker bundle (`libredwg-parser-worker.js`). Worker-only usage is a licensing choice, not a platform constraint: it keeps the copyleft LibreDWG parser separate from the main application bundle so that MIT-licensed apps can integrate DWG support more safely.
 
-### AcDbNativeDxfConverter vs dxf-json-converter (DXF file support)
-
-`@mlightcad/data-model` ships a built-in DXF converter, `AcDbNativeDxfConverter`. It is the **recommended** way to read DXF files. The optional GPL alternative `@mlightcad/dxf-json-converter` lives in [dwg-dxf-converter](https://github.com/mlightcad/dwg-dxf-converter).
+### AcDbNativeDxfConverter (DXF file support)
 
-| | `AcDbNativeDxfConverter` (built-in) | `@mlightcad/dxf-json-converter` |
-| --- | --- | --- |
-| Where it lives | `@mlightcad/data-model` | [dwg-dxf-converter](https://github.com/mlightcad/dwg-dxf-converter) |
-| License | MIT | GPL-3.0 (via `@mlightcad/dxf-json`) |
-| Default registration | Yes — registered when you import `data-model` | No — must `register()` yourself (replaces the default) |
-| Execution | Main thread, streaming DXF pairs into the database | Web Worker + ParsedDxf JSON intermediate |
-| Worker / assets | Not required | Requires `dxf-parser-worker.js` |
-| Typical use | New apps; prefer speed and MIT-only DXF | Legacy setups or apps that already depend on `dxf-json` |
+`@mlightcad/data-model` ships a built-in MIT DXF converter, `AcDbNativeDxfConverter`. It is registered by default when `AcDbDatabaseConverterManager` is created, streams DXF pairs into the database on the main thread, and requires no Web Worker or extra parser assets.
 
-`dxf-json-converter` remains available for compatibility, but new code should use the built-in `AcDbNativeDxfConverter` unless you have a specific reason to keep the GPL worker-based path.
+Deprecated GPL alternatives (`@mlightcad/dxf-json-converter`, `@mlightcad/libdxfrw-converter`) live in the separate [dwg-dxf-converter](https://github.com/mlightcad/dwg-dxf-converter) repository.
 
 ## geometry-engine (AcGe classes in AutoCAD ObjectARX)
 
@@ -207,6 +187,40 @@ The key classes in this module are as follows.
 - AcGiRenderer: Interface used to render entities to drawble objects.
 - ...
 
+## Private packages (maintainers)
+
+`@mlightcad/dwg-converter` is **not** part of this public repository and is never
+built or published by public GitHub CI. Maintainers who need it locally can clone
+it into the workspace:
+
+```bash
+pnpm setup:private
+pnpm install
+pnpm --filter @mlightcad/dwg-converter build
+```
+
+Override the clone URL with `DWG_CONVERTER_REPO_URL` if needed. The directory
+`packages/dwg-converter` is gitignored so it cannot be committed here. Local
+`pnpm install` may temporarily add that package to `pnpm-lock.yaml` — **do not
+commit** those lockfile changes; public CI must keep a lockfile without it.
+
+**Customers** install the same package from GitHub Packages (not public npm). Do
+not point the whole `@mlightcad` scope at GitHub Packages—only authenticate, then
+install with an explicit registry:
+
+```ini
+# .npmrc
+registry=https://registry.npmjs.org/
+//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
+```
+
+```bash
+pnpm add @mlightcad/data-model
+pnpm add @mlightcad/dwg-converter --registry https://npm.pkg.github.com
+```
+
+Publishing `@mlightcad/dwg-converter` happens only from its private repository CI.
+
 ## Contributing
 
 Contributions are welcome! Please open issues or pull requests for bug fixes, new features, or suggestions. For bug reports, providing a link to the problematic drawing will help in reproducing and fixing the issue.
@@ -215,61 +229,52 @@ Contributions are welcome! Please open issues or pull requests for bug fixes, ne
 
 This project is generally licensed under the [MIT License](LICENSE). However, this license does not apply to `@mlightcad/libredwg-converter` (GPL-3.0) in this repository.
 
-The GPL converters `@mlightcad/dxf-json-converter` and `@mlightcad/libdxfrw-converter` live in the separate [dwg-dxf-converter](https://github.com/mlightcad/dwg-dxf-converter) repository. Please refer to each package's license for details.
+Deprecated GPL converters (`@mlightcad/dxf-json-converter`, `@mlightcad/libdxfrw-converter`) live in the separate [dwg-dxf-converter](https://github.com/mlightcad/dwg-dxf-converter) repository. Please refer to that repository and each package's license for details.
 
 ### Prefer the built-in DXF converter
 
-For DXF files, use the built-in **`AcDbNativeDxfConverter`** in `@mlightcad/data-model` whenever possible:
+For DXF files, use the built-in **`AcDbNativeDxfConverter`** in `@mlightcad/data-model`:
 
-- **No GPL license issues for DXF** — it is MIT-licensed and part of the core SDK; you do not need `@mlightcad/dxf-json-converter`.
+- **No GPL license issues for DXF** — it is MIT-licensed and part of the core SDK.
 - **Faster and simpler** — streams DXF into the database on the main thread with no Web Worker and no extra parser assets.
-- **Registered by default** — importing `@mlightcad/data-model` is enough to call `AcDbDatabase.read(..., AcDbFileType.DXF)`.
+- **Registered by default** — accessing `AcDbDatabaseConverterManager` is enough to call `AcDbDatabase.read(..., AcDbFileType.DXF)`.
 
-Reserve `@mlightcad/dxf-json-converter` for legacy apps that already depend on it. For DWG, you still need a separate converter package (prefer `@mlightcad/libredwg-converter` with worker mode).
+For DWG, register a separate converter package (prefer `@mlightcad/libredwg-converter` with worker mode).
 
 ### GPL copyleft and Web Worker isolation
 
 The MIT-licensed core (`@mlightcad/data-model`, `@mlightcad/geometry-engine`, `@mlightcad/graphic-interface`, `@mlightcad/common`) does **not** depend on any GPL parser. Reading DXF through `AcDbNativeDxfConverter` stays entirely under MIT.
 
 GPL copyleft therefore does **not** automatically apply to your application merely because you use the RealDWG-Web SDK—**provided that any GPL parser code you do use runs only inside separate Web Worker bundles**.
 
-If you still use `@mlightcad/dxf-json-converter` and/or `@mlightcad/libredwg-converter`, the recommended integration is:
+For DWG via `@mlightcad/libredwg-converter`, the recommended integration is:
 
 ```ts
-// Optional DXF replacement (not needed if you keep AcDbNativeDxfConverter)
-const dxfConverter = new AcDbDxfConverter({
-  useWorker: true,
-  parserWorkerUrl: './assets/dxf-parser-worker.js'
-})
-
 const dwgConverter = new AcDbLibreDwgConverter({
   useWorker: true,
   parserWorkerUrl: './assets/libredwg-parser-worker.js'
 })
 ```
 
-Deploy the worker scripts (`dxf-parser-worker.js` if used, `libredwg-parser-worker.js`) from each converter package's `dist/` folder as static assets (see [example vite config](./packages/example/vite.config.ts)).
+Deploy `libredwg-parser-worker.js` from `@mlightcad/libredwg-converter`'s `dist/` folder as a static asset (see [example vite config](./packages/example/vite.config.ts)).
 
 **How this limits copyleft propagation**
 
 | Component | License | Worker isolation |
 | --- | --- | --- |
 | Core SDK (`data-model`, including `AcDbNativeDxfConverter`) | MIT | N/A — no GPL dependency |
-| `dxf-json-converter` / `libredwg-converter` (main bundle) | GPL | Orchestrates parsing; GPL parser execution stays in worker |
-| `dxf-parser-worker.js` / `libredwg-parser-worker.js` | GPL | Separate bundle; loaded at runtime; communicates via `postMessage` |
-| `libdxfrw-converter` | GPL-2.0 | **No** worker isolation — parser runs on the main thread |
+| `libredwg-converter` (main bundle) | GPL | Orchestrates parsing; GPL parser execution stays in worker |
+| `libredwg-parser-worker.js` | GPL | Separate bundle; loaded at runtime; communicates via `postMessage` |
 
-When `useWorker: true` is configured and the worker scripts are deployed separately:
+When `useWorker: true` is configured and the worker script is deployed separately:
 
-1. GPL parser code is bundled only into the worker scripts, not into your main application bundle.
+1. GPL parser code is bundled only into the worker script, not into your main application bundle.
 2. The worker and main thread exchange data through `postMessage` (file bytes in, parsed JSON model out)—a runtime boundary rather than static linking of GPL code into the MIT core.
-3. Your MIT-licensed application code can stay under MIT, while the GPL worker bundles remain separate distributable components that must comply with GPL on their own (source availability, license notice, etc.).
+3. Your MIT-licensed application code can stay under MIT, while the GPL worker bundle remains a separate distributable component that must comply with GPL on its own (source availability, license notice, etc.).
 
 **Important caveats**
 
 - **Prefer `AcDbNativeDxfConverter` for DXF** to avoid GPL entirely for that format.
 - **Worker scripts are still GPL.** You must satisfy GPL obligations for those bundles (e.g., provide corresponding source and license notices when you distribute them).
-- **DXF via `dxf-json-converter` on the main thread does not isolate GPL code.** That package can parse on the main thread when `useWorker: false`; that mode links GPL parser code into the same JavaScript context as your app. Use `useWorker: true` if you must use it and want worker-based isolation.
 - **DWG via LibreDWG is worker-only.** `@mlightcad/libredwg-converter` requires a Web Worker; it cannot run on the main thread.
-- **`@mlightcad/libdxfrw-converter` is different.** It does not provide a worker-based parser bundle; using it loads GPL libdxfrw code on the main thread. Prefer `@mlightcad/libredwg-converter` with worker mode if copyleft isolation matters for your deployment.
 - **This is an architectural description, not legal advice.** Interpretation of GPL in browser/Web Worker contexts may vary by jurisdiction and use case. Consult qualified legal counsel for your product if license compliance is critical.

package.json

@@ -24,6 +24,7 @@
     "lint:fix": "nx run-many -t lint:fix",
     "publish:package": "pnpm -r publish --access public --no-git-checks",
     "release": "node tools/release.mjs",
+    "setup:private": "node tools/setup-private-packages.mjs",
     "sync:versions": "node tools/sync-versions.mjs",
     "sync:versions:check": "node tools/sync-versions.mjs --check",
     "test": "jest",
@@ -59,7 +60,7 @@
     "typedoc": "^0.27.4",
     "typescript": "^5.5.2",
     "typescript-eslint": "^8.4.0",
-    "vite": "^6.4.3",
+    "vite": "6.4.3",
     "vite-plugin-strip-comments": "^0.0.10"
   },
   "lint-staged": {

packages/data-model/__tests__/AcDbDatabaseConverterManager.spec.ts

@@ -2,15 +2,21 @@ import {
   AcDbDatabaseConverterManager,
   AcDbFileType
 } from '../src/database/AcDbDatabaseConverterManager'
+import { AcDbNativeDxfConverter } from '../src/dxf/AcDbNativeDxfConverter'
 
 describe('AcDbDatabaseConverterManager', () => {
   it('creates a singleton instance', () => {
     const manager = AcDbDatabaseConverterManager.instance
     expect(AcDbDatabaseConverterManager.createInstance()).toBe(manager)
   })
 
+  it('registers a native DXF converter by default', () => {
+    const manager = AcDbDatabaseConverterManager.instance
+    expect(manager.get(AcDbFileType.DXF)).toBeInstanceOf(AcDbNativeDxfConverter)
+  })
+
   it('replaces a DXF converter when register is called again', () => {
-    // Mirrors production: data-model registers AcDbNativeDxfConverter by default,
+    // Mirrors production: the manager registers AcDbNativeDxfConverter by default,
     // then apps may replace it (e.g. with AcDbDxfConverter from dxf-json-converter).
     const manager = AcDbDatabaseConverterManager.instance
     const nativeDefault = { read: jest.fn(), name: 'native' } as any

packages/data-model/__tests__/AcDbEntity.spec.ts

@@ -175,7 +175,7 @@ describe('AcDbEntity.color resolution', () => {
     acdbHostApplicationServices().workingDatabase = db
   })
 
-  it('uses CECOLOR when entity color is explicitly ByBlock', () => {
+  it('resolves ByBlock without INSERT owner to ACI 7 foreground, not CECOLOR', () => {
     addLayerWithColor('0', 0x101010)
     db.clayer = '0'
     db.cecolor = new AcCmColor().setRGBValue(0x336699)
@@ -188,10 +188,12 @@ describe('AcDbEntity.color resolution', () => {
     line.color.setByBlock()
 
     expect(line.color.isByBlock).toBe(true)
-    expect(line.resolvedColor.RGB).toBe(0x336699)
+    expect(line.resolvedColor.isForeground).toBe(true)
+    expect(line.resolvedColor.colorIndex).toBe(7)
+    expect(line.resolvedColor.RGB).not.toBe(0x336699)
   })
 
-  it('resolves ByBlock through current layer when CECOLOR is ByLayer', () => {
+  it('keeps ByBlock as foreground even when CECOLOR is ByLayer', () => {
     addLayerWithColor('ENTITY_LAYER', 0x00ff00)
     addLayerWithColor('CURRENT_LAYER', 0x112233)
     db.clayer = 'CURRENT_LAYER'
@@ -204,7 +206,9 @@ describe('AcDbEntity.color resolution', () => {
     line.layer = 'ENTITY_LAYER'
     line.color.setByBlock()
 
-    expect(line.resolvedColor.RGB).toBe(0x112233)
+    expect(line.resolvedColor.isForeground).toBe(true)
+    expect(line.resolvedColor.colorIndex).toBe(7)
+    expect(line.resolvedColor.RGB).not.toBe(0x112233)
   })
 
   it('resolves ByLayer against the entity layer color', () => {