@linkiez/dxf-renew 7.0.0 → 7.2.0

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,9 +4,57 @@ 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.
+ *
+ * Each value is a percentage (0..100) of the viewport minimum dimension.
+ */
+export interface DimensionAutoScaleViewportPercentages {
+  /** Arrowhead marker size (markerWidth/markerHeight) */
+  arrowSize?: number
+  /** Text height (`font-size`) */
+  textHeight?: number
+  /** Extension line offset from the measured points */
+  extLineOffset?: number
+  /** Extension line overshoot beyond the dimension line */
+  extLineExtension?: number
+}
+
 export interface ToSVGOptions {
   width?: number
   height?: number
+  dimension?: {
+    /**
+     * Automatically scale DIMENSION arrow size, extension endpoints, and
+     * text height estimates based on the SVG viewport size.
+     */
+    autoScale?: boolean
+
+    /**
+     * Viewport reference size used by DIMENSION autoScale.
+     * Scale factor is: min(viewBoxWidth, viewBoxHeight) / autoScaleViewportReference.
+     * Default: 40.
+     */
+    autoScaleViewportReference?: number
+
+    /**
+     * Per-element viewport-percentage overrides for DIMENSION autoScale.
+     *
+     * When provided (and `autoScale` is enabled), these values set the final
+     * sizes directly as a percentage of the viewport minimum dimension:
+     * `size = min(viewBoxWidth, viewBoxHeight) * (percent / 100)`.
+     *
+     * Percent values are expected in the `0..100` range.
+     */
+    autoScaleViewportPercentages?: DimensionAutoScaleViewportPercentages
+  }
 }
 
 export interface Config {

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

@@ -1,6 +1,7 @@
 // DXF Tables parsing types
 
 import type { Point2D, Point3D } from './common'
+import type { DXFTuple } from './dxf'
 
 /**
  * Partial point for parsing (all coordinates optional)
@@ -116,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
@@ -408,7 +457,118 @@ export interface DimStyleInternal {
 /**
  * DXF Objects section result
  */
+export interface DictionaryObject {
+  type: 'DICTIONARY'
+  handle?: string | number
+  ownerHandle?: string | number
+  entries: Record<string, string>
+}
+
+export interface XRecordObject {
+  type: 'XRECORD'
+  handle?: string | number
+  ownerHandle?: string | number
+
+  /** Raw tuples for downstream consumers (excluding the initial 0/XRECORD tuple). */
+  tuples: DXFTuple[]
+}
+
+export interface ImageDefObject {
+  type: 'IMAGEDEF'
+  handle?: string | number
+
+  /** Soft-pointer ID/handle to the ACAD_IMAGE_dict dictionary (when present). */
+  ownerHandle?: string | number
+
+  /** File name of the referenced image. */
+  fileName?: string
+
+  /** Image size in pixels (when available). */
+  pixelSizeX?: number
+  pixelSizeY?: number
+
+  /** Raw tuples for downstream consumers (excluding the initial 0/IMAGEDEF tuple). */
+  tuples: DXFTuple[]
+}
+
+export interface ImageDefReactorObject {
+  type: 'IMAGEDEF_REACTOR'
+  handle?: string | number
+
+  /** Object ID/handle for the associated IMAGE entity (when present). */
+  imageHandle?: string | number
+
+  /** Raw tuples for downstream consumers (excluding the initial 0/IMAGEDEF_REACTOR tuple). */
+  tuples: DXFTuple[]
+}
+
+export type UnderlayDefinitionObjectType =
+  | 'UNDERLAYDEFINITION'
+  | 'PDFDEFINITION'
+  | 'DWFDEFINITION'
+  | 'DGNDEFINITION'
+
+export interface UnderlayDefinitionObject {
+  type: UnderlayDefinitionObjectType
+  handle?: string | number
+
+  /** Soft-pointer ID/handle to the owning dictionary (when present). */
+  ownerHandle?: string | number
+
+  /** File name or path of the referenced underlay. */
+  fileName?: string
+
+  /** Underlay name within the file (e.g., sheet name). */
+  underlayName?: string
+
+  /** Raw tuples for downstream consumers (excluding the initial 0/<TYPE> tuple). */
+  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[]
+
+  /** DICTIONARY objects keyed by handle */
+  dictionaries?: Record<string, DictionaryObject>
+
+  /** XRECORD objects keyed by handle */
+  xRecords?: Record<string, XRecordObject>
+
+  /** IMAGEDEF objects keyed by handle */
+  imageDefs?: Record<string, ImageDefObject>
+
+  /** IMAGEDEF_REACTOR objects keyed by handle */
+  imageDefReactors?: Record<string, ImageDefReactorObject>
+
+  /** 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/tolerance-entity.ts

@@ -0,0 +1,20 @@
+// TOLERANCE entity type (feature control frame)
+
+import type { BaseEntity } from './base-entity'
+import type { Point3D } from './common'
+
+export interface ToleranceEntity extends BaseEntity {
+  type: 'TOLERANCE'
+
+  /** Insertion point (WCS). */
+  insertionPoint: Point3D
+
+  /** Raw tolerance string (may include control codes like %%v). */
+  text?: string
+
+  /** Dimension style name (group code 3). */
+  dimensionStyleName?: string
+
+  /** X-axis direction vector (group codes 11/21/31). */
+  xAxisDirection?: Point3D
+}

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/underlay-entity.ts

@@ -0,0 +1,35 @@
+// UNDERLAY entity types (DWFUNDERLAY / DGNUNDERLAY / PDFUNDERLAY)
+
+import type { BaseEntity } from './base-entity'
+import type { Point3D } from './common'
+
+export interface UnderlayReferenceEntityBase extends BaseEntity {
+  insertionPoint: Point3D
+  scale: Point3D
+  rotation?: number
+  normal?: Point3D
+
+  /** Hard reference to UNDERLAYDEFINITION object. */
+  underlayDefinitionHandle?: string
+
+  /** Display properties bitmask. */
+  flags?: number
+
+  /** Contrast in range [0, 100]. */
+  contrast?: number
+
+  /** Fade in range [0, 100]. */
+  fade?: number
+}
+
+export interface DwfUnderlayEntity extends UnderlayReferenceEntityBase {
+  type: 'DWFUNDERLAY'
+}
+
+export interface DgnUnderlayEntity extends UnderlayReferenceEntityBase {
+  type: 'DGNUNDERLAY'
+}
+
+export interface PdfUnderlayEntity extends UnderlayReferenceEntityBase {
+  type: 'PDFUNDERLAY'
+}

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/src/util/escapeXmlText.ts

@@ -0,0 +1,10 @@
+export default function escapeXmlText(value: string): string {
+  // Escape text for use inside XML/SVG text nodes.
+  // Keep it small and dependency-free.
+  return value
+    .split('&').join('&')
+    .split('<').join('&lt;')
+    .split('>').join('&gt;')
+    .split('"').join('&quot;')
+    .split("'").join('&apos;')
+}

package/tools/browser_test_server.cjs

@@ -0,0 +1,87 @@
+const http = require('node:http')
+const { createReadStream, existsSync, statSync } = require('node:fs')
+const { extname, join, normalize, resolve } = require('node:path')
+
+const projectRoot = resolve(__dirname, '..')
+const port = Number(process.env.PORT || 4173)
+
+const harnessHtmlPath = join(projectRoot, 'test', 'browser', 'harness.html')
+const distBundlePath = join(projectRoot, 'dist', 'dxf.js')
+const fixturesDir = join(projectRoot, 'test', 'resources')
+
+function sendText(res, statusCode, text, contentType = 'text/plain; charset=utf-8') {
+  res.writeHead(statusCode, { 'Content-Type': contentType })
+  res.end(text)
+}
+
+function contentTypeForPath(filePath) {
+  const ext = extname(filePath).toLowerCase()
+  switch (ext) {
+    case '.html':
+      return 'text/html; charset=utf-8'
+    case '.js':
+      return 'text/javascript; charset=utf-8'
+    case '.dxf':
+      return 'text/plain; charset=utf-8'
+    case '.json':
+      return 'application/json; charset=utf-8'
+    default:
+      return 'application/octet-stream'
+  }
+}
+
+function safeJoin(baseDir, requestedPath) {
+  const cleaned = requestedPath.replace(/^\/+/, '')
+  const target = normalize(join(baseDir, cleaned))
+  const resolvedBase = resolve(baseDir)
+  const resolvedTarget = resolve(target)
+  if (!resolvedTarget.startsWith(resolvedBase + '/')) {
+    return null
+  }
+  return resolvedTarget
+}
+
+const server = http.createServer((req, res) => {
+  const url = new URL(req.url || '/', `http://${req.headers.host || 'localhost'}`)
+  const pathname = url.pathname
+
+  if (pathname === '/' || pathname === '/harness') {
+    if (!existsSync(harnessHtmlPath)) {
+      return sendText(res, 500, 'Missing test/browser/harness.html')
+    }
+    res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' })
+    return createReadStream(harnessHtmlPath).pipe(res)
+  }
+
+  if (pathname === '/dist/dxf.js') {
+    if (!existsSync(distBundlePath)) {
+      return sendText(
+        res,
+        500,
+        'Missing dist/dxf.js. Run `yarn dist` before running browser tests.'
+      )
+    }
+    res.writeHead(200, { 'Content-Type': 'text/javascript; charset=utf-8' })
+    return createReadStream(distBundlePath).pipe(res)
+  }
+
+  if (pathname.startsWith('/fixtures/')) {
+    const fixtureName = pathname.slice('/fixtures/'.length)
+    const fixturePath = safeJoin(fixturesDir, fixtureName)
+    if (!fixturePath) {
+      return sendText(res, 400, 'Invalid fixture path')
+    }
+    if (!existsSync(fixturePath) || !statSync(fixturePath).isFile()) {
+      return sendText(res, 404, 'Fixture not found')
+    }
+    res.writeHead(200, { 'Content-Type': contentTypeForPath(fixturePath) })
+    return createReadStream(fixturePath).pipe(res)
+  }
+
+  return sendText(res, 404, 'Not found')
+})
+
+server.listen(port, () => {
+  // Used by Playwright webServer readiness checks.
+  console.log(`Browser test server listening on http://localhost:${port}`)
+})