@schemd/core 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Stable public entry point for the `schemd` server-side compiler.
+ *
+ * All runtime exports are dependency-free. The Marked integration imports
+ * Marked contracts as types only, so applications pay for no Markdown runtime
+ * unless they already provide one at the host boundary.
+ *
+ * @packageDocumentation
+ */
+export { parseSchematic, parseSchematicColor, parseSchematicFence } from './parser.js';
+export { renderSchematic } from './renderer.js';
+export { schematicMarkedExtension } from './marked-extension.js';
+export { mathLabelGlyphLength, mathLabelText, parseMathLabel, renderMathLabelTspans, type MathLabelSegment, type MathLabelSegmentKind } from './math-label.js';
+export { MAX_SCHEMATIC_COMPONENTS, MAX_SCHEMATIC_CONNECTIONS, MAX_SCHEMATIC_SOURCE_CHARACTERS, MAX_SCHEMATIC_SVG_OUTPUT_BYTES, SCHEMATIC_LIMITS } from './limits.js';
+export { classicalGateHeight, componentObstacleRectangle, componentRectangle, componentTextAnchors, distributedCoordinate, enumerateComponentPorts, positionIcPin, PORT_HOTSPOT_RADIUS, resolvePortPoint, routeConnections, routeConnection, SCHEMATIC_BRIDGE_RADIUS, SCHEMATIC_OBSTACLE_CLEARANCE, validateDocumentGeometry, type RoutedConnection, type ComponentTextAnchors, type ComponentPort, type IcPinSide, type SchematicRectangle } from './layout.js';
+export { ANALOG_KINDS, COMPONENT_KINDS, CLASSICAL_GATE_KINDS, DIODE_TYPES, GROUND_STYLES, PASSIVE_KINDS, QUANTUM_GATE_KINDS, SCHEMATIC_SIGNAL_MARKERS, SEMANTIC_COLORS, TRANSISTOR_TYPES, SCHEMD_OUTPUT_MODES, SchematicSyntaxError, type AnalogKind, type CompileSchematicOptions, type ClassicalGateComponent, type ClassicalGateKind, type ComponentKind, type DiodeComponent, type DiodeType, type GroundComponent, type GroundStyle, type IcComponent, type IntegratedCircuitComponent, type IntegratedCircuitPins, type PassiveComponent, type PassiveKind, type PortComponent, type SemanticColor, type SchematicBounds, type SchematicComponent, type SchematicConnection, type SchematicColor, type SchematicDocument, type SchematicEndpoint, type SchematicFence, type SchematicSignalMarker, type SchematicMarkedOptions, type SchematicPoint, type SchemdOutputMode, type TransistorComponent, type TransistorType, type QuantumGateComponent, type QuantumGateKind } from './types.js';

package/dist/index.js

@@ -0,0 +1,7 @@
+export { parseSchematic, parseSchematicColor, parseSchematicFence } from './parser.js';
+export { renderSchematic } from './renderer.js';
+export { schematicMarkedExtension } from './marked-extension.js';
+export { mathLabelGlyphLength, mathLabelText, parseMathLabel, renderMathLabelTspans } from './math-label.js';
+export { MAX_SCHEMATIC_COMPONENTS, MAX_SCHEMATIC_CONNECTIONS, MAX_SCHEMATIC_SOURCE_CHARACTERS, MAX_SCHEMATIC_SVG_OUTPUT_BYTES, SCHEMATIC_LIMITS } from './limits.js';
+export { classicalGateHeight, componentObstacleRectangle, componentRectangle, componentTextAnchors, distributedCoordinate, enumerateComponentPorts, positionIcPin, PORT_HOTSPOT_RADIUS, resolvePortPoint, routeConnections, routeConnection, SCHEMATIC_BRIDGE_RADIUS, SCHEMATIC_OBSTACLE_CLEARANCE, validateDocumentGeometry } from './layout.js';
+export { ANALOG_KINDS, COMPONENT_KINDS, CLASSICAL_GATE_KINDS, DIODE_TYPES, GROUND_STYLES, PASSIVE_KINDS, QUANTUM_GATE_KINDS, SCHEMATIC_SIGNAL_MARKERS, SEMANTIC_COLORS, TRANSISTOR_TYPES, SCHEMD_OUTPUT_MODES, SchematicSyntaxError } from './types.js';

package/dist/layout.d.ts

@@ -0,0 +1,151 @@
+/**
+ * Deterministic component geometry, terminal resolution, and wire routing.
+ *
+ * The layout pass performs bounded arithmetic directly in SVG viewBox units;
+ * it has no graph-layout dependency, mutable global state, DOM measurement, or
+ * asynchronous work. Orthogonal traces avoid expanded component AABBs and later
+ * crossings receive compact engineering bridge arcs in source order.
+ *
+ * @packageDocumentation
+ */
+import { type ClassicalGateComponent, type IntegratedCircuitComponent, type SchematicComponent, type SchematicConnection, type SchematicDocument, type SchematicFence, type SchematicPoint } from './types.js';
+/** Axis-aligned rectangle expressed in absolute schematic coordinates. */
+export interface SchematicRectangle {
+    /** Inclusive left extent. */
+    minX: number;
+    /** Inclusive top extent. */
+    minY: number;
+    /** Inclusive right extent. */
+    maxX: number;
+    /** Inclusive bottom extent. */
+    maxY: number;
+}
+/** Render-ready connection path and the points used for bounds validation. */
+export interface RoutedConnection {
+    /** Compact SVG path-data string. */
+    d: string;
+    /** At least two absolute points spanning endpoints, controls, corners, and bridge extrema. */
+    points: readonly [SchematicPoint, SchematicPoint, ...SchematicPoint[]];
+}
+/** External text-row baselines and fitted widths relative to a component origin. */
+export interface ComponentTextAnchors {
+    /** Vertical designator baseline offset. */
+    designatorY: number;
+    /** Vertical human-readable label baseline offset. */
+    labelY: number;
+    /** Estimated designator width in viewBox units. */
+    designatorWidth: number;
+    /** Estimated label width after micro-math translation. */
+    labelWidth: number;
+}
+/** A canonical, physically rendered component terminal and its absolute SVG coordinate. */
+export interface ComponentPort {
+    /** Canonical terminal name emitted by full-mode interaction hooks. */
+    readonly id: string;
+    /** Absolute center of the physical terminal. */
+    readonly point: SchematicPoint;
+}
+/** One edge of a polymorphic integrated-circuit body. */
+export type IcPinSide = 'left' | 'right' | 'top' | 'bottom';
+/** An eight-pixel target satisfies the minimum pointer hotspot without changing vector geometry. */
+export declare const PORT_HOTSPOT_RADIUS = 4;
+/** Physical clearance between an orthogonal trace and a component body. */
+export declare const SCHEMATIC_OBSTACLE_CLEARANCE = 12;
+/** Radius of the engineering crossover arc inserted at non-junction wire crossings. */
+export declare const SCHEMATIC_BRIDGE_RADIUS = 5;
+/**
+ * Evenly distribute a terminal within a centered span while preserving edge clearance.
+ *
+ * @param index - Zero-based item index.
+ * @param count - Positive number of items in the distribution.
+ * @param span - Total centered span in viewBox units.
+ * @returns Relative coordinate between negative and positive half-span.
+ */
+export declare function distributedCoordinate(index: number, count: number, span: number): number;
+/**
+ * Compute a classical gate height that scales with its busiest terminal side.
+ *
+ * @param component - Validated classical gate.
+ * @returns Height in viewBox units, never smaller than 48.
+ */
+export declare function classicalGateHeight(component: ClassicalGateComponent): number;
+/**
+ * Position an already-indexed IC pin in O(1), without scanning any side list.
+ *
+ * @param component - Integrated circuit owning the side list.
+ * @param side - Physical edge on which the pin is declared.
+ * @param index - Zero-based index within that edge's pin array.
+ * @returns Absolute terminal point 16 units beyond the IC body.
+ * @throws {RangeError} When `index` is non-integral or outside the selected side.
+ */
+export declare function positionIcPin(component: IntegratedCircuitComponent, side: IcPinSide, index: number): SchematicPoint;
+/**
+ * Resolve a validated, named component port into absolute schematic coordinates.
+ *
+ * @param component - Component owning the previously validated terminal.
+ * @param port - Canonical name or supported alias.
+ * @returns Absolute terminal coordinate used by routing and interaction hotspots.
+ * @throws {Error} When called with an endpoint the semantic parser did not validate.
+ */
+export declare function resolvePortPoint(component: SchematicComponent, port: string): SchematicPoint;
+/**
+ * Enumerate each physical terminal exactly once. Alias spellings deliberately resolve through
+ * `resolvePortPoint` but do not create duplicate interactive targets.
+ *
+ * @param component - Component whose canonical terminals should be exposed.
+ * @returns Port descriptors in stable physical/source order.
+ */
+export declare function enumerateComponentPorts(component: SchematicComponent): readonly ComponentPort[];
+/**
+ * Return the AABB used by orthogonal routing, including engineering clearance.
+ *
+ * @param component - Component treated as a routing obstacle.
+ * @param clearance - Optional non-negative margin; defaults to 12 units.
+ * @returns Expanded physical-body rectangle.
+ * @throws {RangeError} For negative or non-finite clearance values.
+ */
+export declare function componentObstacleRectangle(component: SchematicComponent, clearance?: number): SchematicRectangle;
+/**
+ * Calculate a deterministic line, cubic Bézier, or orthogonal trace.
+ *
+ * @param connection - Validated directed connection.
+ * @param components - Complete component map used for endpoint and obstacle lookup.
+ * @returns SVG path data plus control/corner points for later bounds checks.
+ */
+export declare function routeConnection(connection: SchematicConnection, components: ReadonlyMap<string, SchematicComponent>): RoutedConnection;
+/**
+ * Route connections in source order and bridge only the later trace at a true crossing.
+ *
+ * A fixed spatial bucket bounds comparisons in typical sparse diagrams. Parallel
+ * overlaps, endpoint contacts, Bézier paths, and straight diagonal traces are not bridged.
+ *
+ * @param connections - Validated connections in deterministic source order.
+ * @param components - Complete component map.
+ * @returns Routes in the same order, with crossings applied to later orthogonal traces.
+ */
+export declare function routeConnections(connections: readonly SchematicConnection[], components: ReadonlyMap<string, SchematicComponent>): readonly RoutedConnection[];
+/**
+ * Calculate external designator and label fitting metrics.
+ *
+ * @param component - Component supplying identity, label, and physical height.
+ * @returns Relative baselines and conservative width estimates.
+ */
+export declare function componentTextAnchors(component: SchematicComponent): ComponentTextAnchors;
+/**
+ * Calculate complete component bounds, including text and interactive port radii.
+ *
+ * @param component - Component to measure.
+ * @returns Absolute AABB encompassing vectors, label rows, and port hotspots.
+ */
+export declare function componentRectangle(component: SchematicComponent): SchematicRectangle;
+/**
+ * Validate final generated geometry after terminal distribution and wire routing.
+ *
+ * This complements lexical origin checks and prevents component stubs, dynamic
+ * IC pins, labels, bridge extrema, and routed control points from escaping the viewBox.
+ *
+ * @param document - Parsed immutable schematic document.
+ * @param fence - Intrinsic canvas contract.
+ * @throws {SchematicSyntaxError} At the originating component or connection line.
+ */
+export declare function validateDocumentGeometry(document: SchematicDocument, fence: SchematicFence): void;