Core API

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

Types

ElementKind

import { ElementKind } from 'velo-circuit'

ElementKind.Resistor                 // 'R'
ElementKind.Capacitor                // 'C'
ElementKind.Inductor                   // 'L'
ElementKind.Cpe                        // 'Q'
ElementKind.WarburgInfinite            // 'W'
ElementKind.WarburgShort               // 'Ws'
ElementKind.WarburgOpen                // 'Wo'
ElementKind.Gerischer                  // 'G'
ElementKind.ParallelDiffusionWarburg   // 'Pdw'
ElementKind.ColeCole                   // 'CC'
ElementKind.HavriliakNegami            // 'HN'

ParamDef and ELEMENT_KINDS

Each kind in ELEMENT_KINDS exposes code, label, nParams, and params: ParamDef[] with:

• short — compact on-canvas label (≤2 chars, Greek when needed)
• title — full tooltip / property title (e.g. σ — Warburg coefficient (Ω·s⁻½))

import { ELEMENT_KINDS, ElementKind } from 'velo-circuit'

const def = ELEMENT_KINDS.get(ElementKind.ColeCole)!
// def.code → 'CC'
// def.params → [{ short: 'R', title: 'R — resistance (Ω)' }, …]

CircuitNode

import type { CircuitNode } from 'velo-circuit'

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

EditableGraph

import type { EditableGraph } from 'velo-circuit'

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

Serialization

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

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

const ast = deserialize(dsl)

Validation

import { validate } from 'velo-circuit'

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

Persistence

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

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'

for (const [kind, def] of ELEMENT_KINDS) {
  console.log(def.code, def.label, def.nParams, def.params.map(p => p.short))
}
// R Resistor 1 [ 'R' ]
// Q CPE 2 [ 'Q₀', 'n' ]
// W Warburg (infinite) 1 [ 'σ' ]
// CC Cole-Cole 3 [ 'R', 'τ', 'α' ]
// …

Static SVG preview

import { renderDslPreviewSvg } from 'velo-circuit'

renderDslPreviewSvg('R0-p(R1,C1)-Wo2', {
  themeMode: 'dark',
  colorMode: 'multicolor',
  connectionStyle: 'curved',
})

Junction hubs

import { getJunctionHub } from 'velo-circuit'

const hub = getJunctionHub(junctionNode, graph)
// Wire convergence point for parallel branch dots

See Static SVG Rendering and Render API.

Parser adapter

import { createAdapter, type StrictOptions } from 'velo-circuit'

const adapter = createAdapter({ strict: true })
const { ast, dsl, diagnostics } = adapter.parse('R0-C1')
adapter.setOptions({ validateParamsOnEdit: true })

Parameter resolution

When parameters are not embedded in the DSL string:

import { resolveCircuitParams, formatMissingParams } from 'velo-circuit'

const { values, missing } = resolveCircuitParams(ast, externalParams)
const message = formatMissingParams(missing)

Editor presets (re-exported)

import { allPlugins, litePlugins, minimalPlugins, resolvePlugins, type EditorPreset } from 'velo-circuit'

See Plugins API and Editor Presets.

Related modules

Module	Doc
Editor	Editor API
Grid	Grid API
DSL field	DSL Editor API
Exports map	Package Exports