@tsln/lom-types

v0.1.0npmsourcechangelog

Type declarations for the Ableton Live Object Model (LOM), generated from the LOM reference. They describe every class's children, properties and functions in a type-only Lom namespace, and resolve literal Live API paths to their class.

type T = Lom.ClassAtPath<"live_set tracks 0 devices 1">; // "Device"
type N = Lom.PropertyType<"Track", "name">; // string
type S = Lom.MemberWith<"DeviceIO", "set">; // "routing_type" | "routing_channel" | ...

Runtime access with these types is what @tsln/live-object provides.

Install

npm install --save-dev @tsln/lom-types

The declarations are global, so list the package in types rather than importing it:

{
  "compilerOptions": {
    "types": ["@tsln/max-types", "@tsln/lom-types"]
  }
}

Files

• index.d.ts is generated by pnpm generate:lom at the root of this repository: Lom.Classes describes every class, and Lom.ClassAtPath<P> resolves a literal path such as "live_set tracks 0 devices 1" to its class. Corrections to the reference (for example Chain.devices being a list, this_device being a MaxDevice) live in the generator.
• access.d.ts is hand-written: Lom.MemberValue, Lom.Accessors and other helpers for typed access through a wrapper. A wrapper registers itself by merging into Lom.ObjectTypes, which is how @tsln/live-object makes children resolve to LiveObjects.