Which packages should I install?
Normal editing products
Section titled “Normal editing products”Start with:
npm install @aelionsdk/sdkThe SDK facade includes Project and Composition builders, media registration, Session, commands, preview, playback, export facade, diagnostics, persistence helpers, migration, and runtime Materials.
For Vite, also install:
npm install --save-dev @aelionsdk/vite-plugin viteInstall @aelionsdk/export directly when application code needs OPFS/memory sinks, remote provider
types, profile metadata, or checkpointed lower-level export.
npm install @aelionsdk/exportNon-Vite hosts still install runtime dependencies and deploy the documented Worker/Worklet assets; they do not import internal package files.
Material development
Section titled “Material development”npm install --save-dev @aelionsdk/material-sdkIt supplies typed graph/definition builders, deterministic packing, validation, Material Lab,
signing/trust, migrations, golden helpers, and the aelion-material CLI. A product that only runs
already-installed Materials can normally stay on @aelionsdk/sdk.
Lower-level packages
Section titled “Lower-level packages”| Package | Use it directly only for |
|---|---|
@aelionsdk/core | diagnostics, JSON/time primitives, low-level extensions |
@aelionsdk/project-schema | custom Project tooling and server validation |
@aelionsdk/transaction | custom engine host or editing integration |
@aelionsdk/render-ir | custom renderer/exporter |
@aelionsdk/media | custom byte source, index, decoder, cache, or proxy system |
@aelionsdk/audio | custom PCM/audio-clock host |
@aelionsdk/renderer-worker | custom rendering surface/worker integration |
@aelionsdk/capability | standalone capability laboratory |
@aelionsdk/material-compiler | custom Material tooling or backend |
Prefer Session APIs over recreating the SDK’s internal dependency graph in application code.
Version and import rules
Section titled “Version and import rules”- Keep all
@aelionsdk/*packages on the same exact release. - The npm
latesttag currently points to1.2.0; pin the exact version after validation. - Import only package names and documented subpath exports.
- Never import
src/*, generateddist/*, test helpers, or another workspace package’s internals. - Browser support remains runtime capability/preflight, not a package-selection rule.
See Packages and public entry points for the complete 13-package map and the generated API Reference for exact symbols.