@jeffy-g/live-midi-types 0.6.4 → 0.7.1

package/README.md

@@ -13,6 +13,25 @@ It is designed to ensure type safety and data consistency across projects that h
 
 By providing a single source of truth for data structures, this library simplifies development and reduces errors when passing MIDI and project data between different modules.
 
+> ## Type Origin and Gaps
+
+These definitions were **reverse engineered** from Ableton Live 11 `.als` files.  
+Ableton publishes no official specification, so some fields may be missing or misinterpreted.  
+If you encounter inaccuracies, please open an issue or pull request.
+
+> ## Directory Structure
+
+```
+src/
+├─ midi-event.ts      # basic note, control change, and tempo events
+├─ midi-clip.ts       # builds on midi-event to describe clips
+├─ project.ts         # aggregates clips into a project
+├─ ableton-colors.ts  # color utilities
+└─ index.ts           # public exports
+```
+
+Dependencies flow upward: `midi-event` → `midi-clip` → `project`, while `ableton-colors` stands alone.
+
 > ## Installation
 
 You can install the package using npm or yarn:

package/dist/ableton-colors.js

@@ -12,78 +12,16 @@
  * Ableton Live color palette.
  * @date 2025/6/27 4:51:48
  */
-export const abletonColorPalette = [
-  "#ff94a6",
-  "#ffa529",
-  "#cc9927",
-  "#f7f47c",
-  "#bffb00",
-  "#1aff2f",
-  "#25ffa8",
-  "#5cffe8",
-  "#8bc5ff",
-  "#5480e4",
-  "#92a7ff",
-  "#d86ce4",
-  "#e553a0",
-  "#ffffff",
-  "#ff3636",
-  "#f66c03",
-  "#99724b",
-  "#fff034",
-  "#87ff67",
-  "#3dc300",
-  "#00bfaf",
-  "#19e9ff",
-  "#10a4ee",
-  "#007dc0",
-  "#886ce4",
-  "#b677c6",
-  "#ff39d4",
-  "#d0d0d0",
-  "#e2675a",
-  "#ffa374",
-  "#d3ad71",
-  "#edffae",
-  "#d2e498",
-  "#bad074",
-  "#9bc48d",
-  "#d4fde1",
-  "#cdf1f8",
-  "#b9c1e3",
-  "#cdbbe4",
-  "#ae98e5",
-  "#e5dce1",
-  "#a9a9a9",
-  "#c6928b",
-  "#b78256",
-  "#99836a",
-  "#bfba69",
-  "#a6be00",
-  "#7db04d",
-  "#88c2ba",
-  "#9bb3c4",
-  "#85a5c2",
-  "#8393cc",
-  "#a595b5",
-  "#bf9fbe",
-  "#bc7196",
-  "#7b7b7b",
-  "#af3333",
-  "#a95131",
-  "#724f41",
-  "#dbc300",
-  "#85961f",
-  "#539f31",
-  "#0a9c8e",
-  "#236384",
-  "#1a2f96",
-  "#2f52a2",
-  "#624bad",
-  "#a34bad",
-  "#cc2e6e",
-  "#3c3c3c",
-];
+export const abletonColorPalette = "#ff94a6:#ffa529:#cc9927:#f7f47c:#bffb00:#1aff2f:#25ffa8\
+#5cffe8:#8bc5ff:#5480e4:#92a7ff:#d86ce4:#e553a0:#ffffff\
+#ff3636:#f66c03:#99724b:#fff034:#87ff67:#3dc300:#00bfaf\
+#19e9ff:#10a4ee:#007dc0:#886ce4:#b677c6:#ff39d4:#d0d0d0\
+#e2675a:#ffa374:#d3ad71:#edffae:#d2e498:#bad074:#9bc48d\
+#d4fde1:#cdf1f8:#b9c1e3:#cdbbe4:#ae98e5:#e5dce1:#a9a9a9\
+#c6928b:#b78256:#99836a:#bfba69:#a6be00:#7db04d:#88c2ba\
+#9bb3c4:#85a5c2:#8393cc:#a595b5:#bf9fbe:#bc7196:#7b7b7b\
+#af3333:#a95131:#724f41:#dbc300:#85961f:#539f31:#0a9c8e\
+#236384:#1a2f96:#2f52a2:#624bad:#a34bad:#cc2e6e:#3c3c3c".split(":");
 /**
  * Get color code from Ableton color index.
  * @param {number} colorIndex Index of Ableton color palette.

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export * from "./midi-event.js";
 export * from "./midi-clip.js";
 export * from "./project.js";
 export * from "./ableton-colors.js";
-export declare const version = "v0.6.4";
+export declare const version = "v0.7.1";

package/dist/index.js

@@ -2,4 +2,4 @@ export * from "./midi-event.js";
 export * from "./midi-clip.js";
 export * from "./project.js";
 export * from "./ableton-colors.js";
-export const version = "v0.6.4";
+export const version = "v0.7.1";

package/dist/midi-event.d.ts

@@ -9,6 +9,14 @@
  * @file src/midi-event.ts
  * @summary Common MIDI event types for Ableton Live and related tools.
  */
+/**
+ * ```
+ * // Path to `MidiClip` element
+ * `/Ableton/LiveSet/Tracks/MidiTrack[]/DeviceChain/MainSequencer/ClipTimeable/ArrangerAutomation/Events/MidiClip[]`
+ * // this type is `MidiNoteEvent`
+ * `<MidiClip>/Notes/KeyTracks/KeyTrack[]/Notes/MidiNoteEvent[]`
+ * ```
+ */
 export type NoteEvent = {
   /**
    * NOTE: floating number
@@ -18,6 +26,9 @@ export type NoteEvent = {
    * NOTE: floating number
    */
   duration: number;
+  /**
+   * NOTE: Must be an integer. Floating-point values are not valid.
+   */
   pitch: number;
   /**
    * `0` to `127`
@@ -79,7 +90,4 @@ export type TEventMap = {
  * @param {K} type Type of event to check against.
  * @returns {events is TEventMap[K]} True if the events match the specified type.
  */
-export declare const eventsIs: <K extends keyof TEventMap>(
-  events: unknown[],
-  type: K,
-) => events is TEventMap[K];
+export declare const eventsIs: <K extends keyof TEventMap>(events: unknown[], type: K) => events is TEventMap[K];

package/dist/midi-event.js

@@ -17,9 +17,7 @@
  * @param {unknown} value Value to check.
  * @returns {value is Record<string, unknown>} True if the value is an object.
  */
-function isObject(value) {
-  return typeof value === "object" && value !== null;
-}
+const isObject = (value) => typeof value === "object" && value !== null;
 /**
  * Type guard to check if the events array contains a specific type of MIDI event.
  * @template {keyof TEventMap} K

package/dist/project.d.ts

@@ -10,6 +10,14 @@
  */
 import type { TempoEvent } from "./midi-event.ts";
 export type TClipSummary<T extends Record<string, any>> = {
+  /**
+   * ```js
+   * // e.g
+   * "/Ableton/LiveSet/Tracks/MidiTrack[4]/DeviceChain/MainSequencer/ClipTimeable/ArrangerAutomation/Events/MidiClip[3]/@Id"
+   * ```
+   * @date 2026/07/02
+   */
+  originId: string;
   /**
    * ID assigned for use in UI etc.
    *
@@ -28,6 +36,14 @@ export type TClipSummary<T extends Record<string, any>> = {
   annotations?: string;
 } & T;
 export type TTrackInfo<T extends Record<string, any>> = {
+  /**
+   * ```js
+   * // e.g
+   * "/Ableton/LiveSet/Tracks/MidiTrack[4]/@Id"
+   * ```
+   * @date 2026/07/02
+   */
+  originId: string;
   id: string;
   name: string;
   color: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeffy-g/live-midi-types",
-  "version": "0.6.4",
+  "version": "0.7.1",
   "description": "Common TypeScript types for Ableton Live MIDI clip and event data.",
   "type": "module",
   "main": "dist/index.js",