Core API

The core module exports all domain types, the parser bridge, and the state system.

Types

ElementKind

import { ElementKind } from 'velo-circuit-editor'

ElementKind.Resistor      // 'R'
ElementKind.Capacitor    // 'C'
ElementKind.Inductor     // 'L'
ElementKind.Cpe           // 'Q'
ElementKind.WarburgInfinite // 'W'
ElementKind.WarburgShort   // 'Ws'
ElementKind.WarburgOpen    // 'Wo'

CircuitNode

import type { CircuitNode } from 'velo-circuit-editor'

type CircuitNode =
  | { type: 'element'; kind: ElementKind; id: number; paramOffset: number }
  | { type: 'series'; children: CircuitNode[] }
  | { type: 'parallel'; children: CircuitNode[] }

EditableGraph

import type { EditableGraph } from 'velo-circuit-editor'

interface EditableGraph {
  nodes: Map<string, ElementNode>
  connections: Connection[]
  rootNodeId: string | null
}

Serialization

import { serialize, deserialize } from 'velo-circuit-editor'

const dsl = serialize(ast)
// → 'R0-p(R1,C1)-Wo2'

const ast = deserialize(dsl)

Validation

import { validate } from 'velo-circuit-editor'

const result = validate(ast)
// → { issues: [], hasErrors: false, hasWarnings: false }

Persistence

import { serializeCircuit, deserializeCircuit } from 'velo-circuit-editor'

const doc = serializeCircuit(ast, { name: 'My Circuit' })
// → { version: 1, dsl: 'R0-C1', ast: {...}, metadata: {...} }

JSON.stringify(doc, null, 2)

ELEMENT_KINDS Map

import { ELEMENT_KINDS } from 'velo-circuit-editor'

for (const [kind, def] of ELEMENT_KINDS) {
  console.log(def.code, def.label, def.nParams)
}
// R Resistor 1
// C Capacitor 1
// Q CPE 2
// ...