Skip to content

Which packages should I install?

Start with:

Terminal window
npm install @aelionsdk/sdk

The 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:

Terminal window
npm install --save-dev @aelionsdk/vite-plugin vite

Install @aelionsdk/export directly when application code needs OPFS/memory sinks, remote provider types, profile metadata, or checkpointed lower-level export.

Terminal window
npm install @aelionsdk/export

Non-Vite hosts still install runtime dependencies and deploy the documented Worker/Worklet assets; they do not import internal package files.

Terminal window
npm install --save-dev @aelionsdk/material-sdk

It 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.

PackageUse it directly only for
@aelionsdk/corediagnostics, JSON/time primitives, low-level extensions
@aelionsdk/project-schemacustom Project tooling and server validation
@aelionsdk/transactioncustom engine host or editing integration
@aelionsdk/render-ircustom renderer/exporter
@aelionsdk/mediacustom byte source, index, decoder, cache, or proxy system
@aelionsdk/audiocustom PCM/audio-clock host
@aelionsdk/renderer-workercustom rendering surface/worker integration
@aelionsdk/capabilitystandalone capability laboratory
@aelionsdk/material-compilercustom Material tooling or backend

Prefer Session APIs over recreating the SDK’s internal dependency graph in application code.

  • Keep all @aelionsdk/* packages on the same exact release.
  • The npm latest tag currently points to 1.2.0; pin the exact version after validation.
  • Import only package names and documented subpath exports.
  • Never import src/*, generated dist/*, 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.