Skip to content

Packages and public entry points

All public packages are currently 1.2.0 under npm latest. Only paths declared by a package’s exports field are public API; src/*, dist/*, tests, and internal helpers are not.

TierPackagesIntended use
Product entrysdk, export, vite-pluginApplication developers
Extension entrymaterial-sdk, project-schemaMaterial, importer, and Project tooling
Advanced enginecore, capability, media, material-compiler, render-ir, renderer-worker, audio, transactionCustom hosts and engine contributors

All packages share a release version, but direct use of an advanced package opts into a narrower compatibility boundary; follow SemVer, CHANGELOG and the API snapshot.

Main application surface: Aelion.createSession(), Composition and Project builders, time helpers, production media providers, Canvas preview, Session/Player/Transaction/Export APIs, audio analysis and mastering, persistence, migration, isolated Worker extensions, runtime Material registry, and default Project schema.

Seekable memory/OPFS sinks, export profile metadata, remote provider/authorizer contracts, checkpointed muxed export, Worker exporter, and lower-level profile functions. Applications using Session export normally import only sinks and remote types from this package.

Emits and wires Renderer Worker, Export Worker, and AudioWorklet runtime assets. The package also provides Webpack/Rspack integration and helpers for custom copy, Next client boundaries, and CDN asset URLs.

Typed graph/definition builders, deterministic package creation, registry/catalog, Material Lab, signature and trust store, migrations, golden helpers, and the aelion-material CLI.

PackageResponsibility
coreerrors, diagnostics, JSON types, time/frame/sample math
project-schemaProject v1 types, validation, canonical input admission
transactionsemantic editing, transaction engine, history, change sets
render-irProject compilation and audio/visual evaluation contract
mediarange I/O, MP4/WebM indexing, seek/decode, cache, proxy, budgets
audioPCM mix, AudioWorklet clock/transport, video scheduling
renderer-workerworker protocol and WebGL2/WebGPU compositing
capabilityGPU, codec, audio, storage, stream, WASM, and color probes
material-compilergraph type checking, Core Nodes, backend compilation, budgets

Prefer Session APIs whenever they cover the use case. See the generated API Reference for exact symbols and packages/sdk/api-snapshot.md for the reviewed export surface.