ofs-dxf-ts 1.0.0

package/dist/core/dxf-entities.d.ts

@@ -0,0 +1,327 @@
+/**
+ * DXF Entity and Attribute type definitions.
+ * Mirrors ezdxf's entity model for maximum compatibility.
+ * Covers all 23 entity types requested.
+ */
+import type { HatchPatternLine } from './hatch-patterns.js';
+export interface DxfAttribs {
+    layer?: string;
+    color?: number;
+    linetype?: string;
+    lineweight?: number;
+}
+export interface TextAttribs extends DxfAttribs {
+    style?: string;
+    height?: number;
+    rotation?: number;
+    halign?: number;
+    valign?: number;
+}
+export interface BlockRefAttribs extends DxfAttribs {
+    xscale?: number;
+    yscale?: number;
+    zscale?: number;
+    rotation?: number;
+}
+export declare enum TextEntityAlignment {
+    LEFT = 0,
+    CENTER = 1,
+    RIGHT = 2,
+    MIDDLE = 4,
+    MIDDLE_LEFT = 10,
+    MIDDLE_CENTER = 11,
+    MIDDLE_RIGHT = 12,
+    TOP_LEFT = 20,
+    TOP_CENTER = 21,
+    TOP_RIGHT = 22,
+    BOTTOM_LEFT = 30,
+    BOTTOM_CENTER = 31,
+    BOTTOM_RIGHT = 32
+}
+export type EntityType = 'LINE' | 'LWPOLYLINE' | 'POLYLINE' | 'CIRCLE' | 'ARC' | 'ELLIPSE' | 'TEXT' | 'MTEXT' | 'INSERT' | 'POINT' | 'SOLID' | 'TRACE' | 'HATCH' | 'DIMENSION' | 'LEADER' | 'SPLINE' | 'VIEWPORT' | 'IMAGE' | 'WIPEOUT' | 'REGION' | 'MESH' | 'MLEADER';
+export interface DxfEntityBase {
+    type: EntityType;
+    layer: string;
+    color?: number;
+    linetype?: string;
+    lineweight?: number;
+    handle?: string;
+}
+export interface LineEntity extends DxfEntityBase {
+    type: 'LINE';
+    start: [number, number];
+    end: [number, number];
+}
+export interface LwPolylineEntity extends DxfEntityBase {
+    type: 'LWPOLYLINE';
+    points: [number, number][];
+    closed: boolean;
+}
+/** 3D Polyline (heavy polyline with VERTEX sub-entities) */
+export interface PolylineEntity extends DxfEntityBase {
+    type: 'POLYLINE';
+    points: [number, number, number][];
+    closed: boolean;
+}
+export interface CircleEntity extends DxfEntityBase {
+    type: 'CIRCLE';
+    center: [number, number];
+    radius: number;
+}
+export interface ArcEntity extends DxfEntityBase {
+    type: 'ARC';
+    center: [number, number];
+    radius: number;
+    startAngle: number;
+    endAngle: number;
+}
+export interface EllipseEntity extends DxfEntityBase {
+    type: 'ELLIPSE';
+    center: [number, number];
+    majorAxis: [number, number];
+    ratioMinorToMajor: number;
+    startParam: number;
+    endParam: number;
+}
+export interface PointEntity extends DxfEntityBase {
+    type: 'POINT';
+    position: [number, number];
+}
+export interface SolidEntity extends DxfEntityBase {
+    type: 'SOLID';
+    points: [[number, number], [number, number], [number, number], [number, number]];
+}
+export interface TraceEntity extends DxfEntityBase {
+    type: 'TRACE';
+    points: [[number, number], [number, number], [number, number], [number, number]];
+}
+export interface TextEntity extends DxfEntityBase {
+    type: 'TEXT';
+    text: string;
+    position: [number, number];
+    height: number;
+    rotation: number;
+    style: string;
+    halign: number;
+    valign: number;
+    alignmentPoint?: [number, number];
+}
+export interface MTextEntity extends DxfEntityBase {
+    type: 'MTEXT';
+    text: string;
+    position: [number, number];
+    height: number;
+    rotation: number;
+    width: number;
+    style: string;
+    attachmentPoint: number;
+}
+export interface InsertEntity extends DxfEntityBase {
+    type: 'INSERT';
+    blockName: string;
+    position: [number, number];
+    xScale: number;
+    yScale: number;
+    zScale: number;
+    rotation: number;
+}
+export interface SplineEntity extends DxfEntityBase {
+    type: 'SPLINE';
+    degree: number;
+    closed: boolean;
+    controlPoints: [number, number][];
+    fitPoints: [number, number][];
+    knots: number[];
+    weights?: number[];
+}
+export interface HatchEntity extends DxfEntityBase {
+    type: 'HATCH';
+    patternName: string;
+    solid: boolean;
+    scale: number;
+    angle: number;
+    boundaries: HatchBoundary[];
+    /** Custom pattern definition; defaults to the built-in HATCH_PATTERNS entry for `patternName`. */
+    patternLines?: HatchPatternLine[];
+}
+export interface HatchBoundary {
+    type: 'polyline';
+    points: [number, number][];
+    closed: boolean;
+}
+export interface DimensionEntity extends DxfEntityBase {
+    type: 'DIMENSION';
+    dimensionType: number;
+    definitionPoint: [number, number];
+    textMidpoint: [number, number];
+    insertionPoint: [number, number];
+    text: string;
+    rotation: number;
+    style: string;
+    point1?: [number, number];
+    point2?: [number, number];
+}
+export interface LeaderEntity extends DxfEntityBase {
+    type: 'LEADER';
+    vertices: [number, number][];
+    hasArrowhead: boolean;
+    annotationType: number;
+    style: string;
+    annotationText?: string;
+}
+export interface ViewportEntity extends DxfEntityBase {
+    type: 'VIEWPORT';
+    center: [number, number];
+    width: number;
+    height: number;
+    viewCenter: [number, number];
+    viewHeight: number;
+    status: number;
+    id?: number;
+    frozenLayers?: string[];
+    locked?: boolean;
+}
+export interface ImageEntity extends DxfEntityBase {
+    type: 'IMAGE';
+    insertionPoint: [number, number];
+    uVector: [number, number];
+    vVector: [number, number];
+    imageSize: [number, number];
+    imagePath: string;
+    clipBoundary?: [number, number][];
+    brightness?: number;
+    contrast?: number;
+    fade?: number;
+}
+export interface WipeoutEntity extends DxfEntityBase {
+    type: 'WIPEOUT';
+    insertionPoint: [number, number];
+    uVector: [number, number];
+    vVector: [number, number];
+    imageSize: [number, number];
+    clipBoundary: [number, number][];
+}
+export interface RegionEntity extends DxfEntityBase {
+    type: 'REGION';
+    acisData: string[];
+}
+export interface MeshEntity extends DxfEntityBase {
+    type: 'MESH';
+    subdivisionLevel: number;
+    vertices: [number, number, number][];
+    faces: number[][];
+}
+/**
+ * MLEADER — Modern multileader entity (AutoCAD 2008+).
+ * Combines leader lines with text or block content.
+ *
+ * @deprecated The MULTILEADER written for this entity is incomplete and is not
+ * read reliably by AutoCAD. Use `DxfBuilder.addCallout()` instead.
+ */
+export interface MLeaderEntity extends DxfEntityBase {
+    type: 'MLEADER';
+    vertices: [number, number][];
+    text: string;
+    textHeight: number;
+    textWidth: number;
+    textPosition: [number, number];
+    arrowSize: number;
+    style: string;
+    doglegLength: number;
+    leaderType: number;
+    contentType: number;
+}
+export interface TableCellDef {
+    text: string;
+    alignment?: TextEntityAlignment;
+    color?: number;
+    style?: string;
+    /** Number of columns this cell spans (default 1). */
+    colSpan?: number;
+    /** Number of rows this cell spans (default 1). */
+    rowSpan?: number;
+}
+export interface TableDef {
+    position: [number, number];
+    columnWidths: number[];
+    rowHeight: number;
+    /** Per-row heights; rows without an entry use `rowHeight`. */
+    rowHeights?: number[];
+    /**
+     * Rows of cells, HTML-table style: a cell spanning columns/rows covers the
+     * positions to its right/below, and later cells skip covered positions.
+     */
+    rows: TableCellDef[][];
+    layer: string;
+    textHeight: number;
+    headerColor?: number;
+    gridColor?: number;
+    textColor?: number;
+}
+export interface LayoutDef {
+    name: string;
+    paperWidth: number;
+    paperHeight: number;
+    margins: [number, number, number, number];
+    viewports: LayoutViewportDef[];
+}
+export interface LayoutViewportDef {
+    /** Position in paper space (mm) */
+    center: [number, number];
+    width: number;
+    height: number;
+    /** View target in model space */
+    viewCenter: [number, number];
+    /** Model-space height shown by the viewport. Derived from `scale` when omitted. */
+    viewHeight?: number;
+    /** Frozen layers in this viewport */
+    frozenLayers?: string[];
+    /** Scale denominator, e.g. 12500 for 1:12,500. */
+    scale?: number;
+    /** Model units per paper unit at 1:1 — default 0.001 (paper in mm, model in meters). */
+    unitFactor?: number;
+    /** Lock the viewport display so zoom/pan cannot change the scale. */
+    locked?: boolean;
+    rotation?: number;
+}
+export interface GeoReferenceDef {
+    /** Coordinate Reference System (CRS) identifier, e.g. 'EPSG:32647' for UTM Zone 47N */
+    crsId: string;
+    /** Well-Known Text for the CRS (optional, for full definition) */
+    crsWkt?: string;
+    /** Design point in DXF coordinates (model space) */
+    designPoint: [number, number];
+    /** Reference point in geo coordinates (easting, northing or lon, lat) */
+    referencePoint: [number, number];
+    /** North direction in degrees (0 = Y-axis up, positive clockwise) */
+    northDirection: number;
+    /** Scale factor between DXF units and real-world units */
+    scaleFactor: number;
+    /** Coordinate type: 1 = local grid, 2 = projected (UTM), 3 = geographic */
+    coordinateType: number;
+}
+export type DxfEntity = LineEntity | LwPolylineEntity | PolylineEntity | CircleEntity | ArcEntity | EllipseEntity | TextEntity | MTextEntity | InsertEntity | PointEntity | SolidEntity | TraceEntity | SplineEntity | HatchEntity | DimensionEntity | LeaderEntity | ViewportEntity | ImageEntity | WipeoutEntity | RegionEntity | MeshEntity | MLeaderEntity;
+export interface LayerDef {
+    name: string;
+    color: number;
+    linetype: string;
+    frozen?: boolean;
+    locked?: boolean;
+    off?: boolean;
+}
+export interface LinetypeDef {
+    name: string;
+    description: string;
+    /** Dash lengths: positive = dash, negative = gap, 0 = dot. */
+    pattern: number[];
+}
+export interface TextStyleDef {
+    name: string;
+    font: string;
+    height?: number;
+}
+export interface BlockDef {
+    name: string;
+    basePoint: [number, number];
+    entities: DxfEntity[];
+}

package/dist/core/dxf-entities.js

@@ -0,0 +1,22 @@
+/**
+ * DXF Entity and Attribute type definitions.
+ * Mirrors ezdxf's entity model for maximum compatibility.
+ * Covers all 23 entity types requested.
+ */
+// ─── Alignment Enum (matches ezdxf TextEntityAlignment) ───
+export var TextEntityAlignment;
+(function (TextEntityAlignment) {
+    TextEntityAlignment[TextEntityAlignment["LEFT"] = 0] = "LEFT";
+    TextEntityAlignment[TextEntityAlignment["CENTER"] = 1] = "CENTER";
+    TextEntityAlignment[TextEntityAlignment["RIGHT"] = 2] = "RIGHT";
+    TextEntityAlignment[TextEntityAlignment["MIDDLE"] = 4] = "MIDDLE";
+    TextEntityAlignment[TextEntityAlignment["MIDDLE_LEFT"] = 10] = "MIDDLE_LEFT";
+    TextEntityAlignment[TextEntityAlignment["MIDDLE_CENTER"] = 11] = "MIDDLE_CENTER";
+    TextEntityAlignment[TextEntityAlignment["MIDDLE_RIGHT"] = 12] = "MIDDLE_RIGHT";
+    TextEntityAlignment[TextEntityAlignment["TOP_LEFT"] = 20] = "TOP_LEFT";
+    TextEntityAlignment[TextEntityAlignment["TOP_CENTER"] = 21] = "TOP_CENTER";
+    TextEntityAlignment[TextEntityAlignment["TOP_RIGHT"] = 22] = "TOP_RIGHT";
+    TextEntityAlignment[TextEntityAlignment["BOTTOM_LEFT"] = 30] = "BOTTOM_LEFT";
+    TextEntityAlignment[TextEntityAlignment["BOTTOM_CENTER"] = 31] = "BOTTOM_CENTER";
+    TextEntityAlignment[TextEntityAlignment["BOTTOM_RIGHT"] = 32] = "BOTTOM_RIGHT";
+})(TextEntityAlignment || (TextEntityAlignment = {}));

package/dist/core/dxf-serializer.d.ts

@@ -0,0 +1,48 @@
+/**
+ * DXF Format Serializer.
+ * Converts internal entity representations and table records to DXF tag text.
+ * Section assembly (tables, blocks, objects, handle seeding) lives in
+ * template/template-injector, which serves both template and blank documents.
+ */
+import { DxfEntity, HatchEntity, ImageEntity, LayerDef, LinetypeDef, TextStyleDef } from './dxf-entities.js';
+import { HatchPatternLine } from './hatch-patterns.js';
+export declare function nextHandle(): string;
+export declare function resetHandleCounter(start?: number): void;
+/** The handle `nextHandle()` will return next — the value to store in $HANDSEED. */
+export declare function peekHandle(): string;
+/** Format a computed number for DXF: no exponent notation, no negative zero. */
+export declare function fmt(n: number): string;
+/** Handles pre-allocated for one IMAGE entity and its IMAGEDEF / reactor objects. */
+export interface ImageHandles {
+    handle: string;
+    defHandle: string;
+    reactorHandle: string;
+}
+/** Where an entity is written and which document objects it references. */
+export interface EmitContext {
+    /** Owner BLOCK_RECORD handle (code 330). */
+    owner?: string;
+    /** Entity lives in a paper space layout (code 67). */
+    paperSpace?: boolean;
+    /** IMAGE entity → pre-allocated handles. Required to serialize IMAGE. */
+    images?: Map<ImageEntity, ImageHandles>;
+    /** Upper-cased layer name → LAYER handle, used for viewport-frozen layers. */
+    layerHandles?: Map<string, string>;
+}
+declare function serializeEntity(entity: DxfEntity, ctx?: EmitContext): string;
+/** Resolve a hatch's pattern lines (custom or built-in), scaled and rotated for output. */
+export declare function hatchPatternLines(e: HatchEntity): HatchPatternLine[];
+/** LAYER table record. `plotStyle` / `material` are the document's default object handles. */
+export declare function layerRecord(l: LayerDef, handle: string, owner: string, refs?: {
+    plotStyle?: string;
+    material?: string;
+}): string;
+export declare function linetypeRecord(lt: LinetypeDef, handle: string, owner: string): string;
+export declare function textStyleRecord(s: TextStyleDef, handle: string, owner: string): string;
+export declare function blockRecord(name: string, handle: string, owner: string, layoutHandle?: string): string;
+/**
+ * BLOCK … ENDBLK definition. `blockRecordHandle` owns the block and its content.
+ * Paper space layout blocks pass `paperSpace` so their content is flagged 67=1.
+ */
+export declare function blockDefinition(name: string, blockRecordHandle: string, basePoint: [number, number], entities: DxfEntity[], ctx?: EmitContext): string;
+export { serializeEntity };