Skip to content

API reference

This reference documents the public API surface of svg-engine — the symbols exported from each entry point’s public-api.ts. It is derived from the library’s source, which is the source of truth.

Each secondary entry point exposes a curated set of classes, interfaces, types, functions, services, commands and tokens. Anything not exported from an entry point’s public-api.ts is internal and may change without notice. The public surface follows SemVer once the library reaches 1.0.0 (it is currently pre-1.0, so the surface is still hardening).

The headless boundary applies here too: core, render, io, optimize, edit and ai/nlu export no Angular Material/CDK types — only ui and ai/nlu-ui do. See Architecture.

Entry pointWhat it exposesMaterial?
coredata model, immutable tree ops, document, commands, history/state services, geometry, animation, snapshotsNo
renderthe renderer, per-type directives, viewport, node-renderer registryNo
ioimporter/exporter registries + SVG/PNG/SVGZ built-ins, code generatorsNo
optimizeoptimizer registry + built-in passes + optimize commandNo
editselection, transform, tools, plugins, registries, libraries, pages, effectsNo
uishells, panels, dialogs, tool options, servicesYes
ai/nlunatural-language engine, dictionaries, matchers, LLM providerNo
ai/nlu-uicommand input component + voice servicesYes
ai/nlu-voice-wasmon-device Whisper voice providerNo