@musodojo/music-theory-data 21.1.0 → 22.0.0

package/esm/src/data/chords/mod.d.ts

@@ -1,10 +1,18 @@
 import type { LowerCaseRomanNumeral, SeventhChord, Triad, UpperCaseRomanNumeral } from "../../types/chords";
+/** An ordered array containing the fundamental triad qualities of the diatonic major scale. */
 export declare const diatonicTriads: Triad[];
+/** An ordered array containing the fundamental seventh-chord qualities of the diatonic major scale. */
 export declare const diatonicSeventhChords: SeventhChord[];
+/** An ordered array containing the fundamental triad qualities of the harmonic minor scale. */
 export declare const harmonicMinorTriads: Triad[];
+/** An ordered array containing the fundamental seventh-chord qualities of the harmonic minor scale. */
 export declare const harmonicMinorSeventhChords: SeventhChord[];
+/** An ordered array containing the fundamental triad qualities of the melodic minor scale. */
 export declare const melodicMinorTriads: Triad[];
+/** An ordered array containing the fundamental seventh-chord qualities of the melodic minor scale. */
 export declare const melodicMinorSeventhChords: SeventhChord[];
+/** An array mapping 7 index scale degrees to their corresponding upper-case Roman numerals. */
 export declare const upperCaseRomanNumerals: UpperCaseRomanNumeral[];
+/** An array mapping 7 index scale degrees to their corresponding lower-case Roman numerals. */
 export declare const lowerCaseRomanNumerals: LowerCaseRomanNumeral[];
 //# sourceMappingURL=mod.d.ts.map

package/esm/src/data/chords/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/src/data/chords/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,YAAY,EACZ,KAAK,EACL,qBAAqB,EACtB,MAAM,oBAAoB,CAAC;AAE5B,eAAO,MAAM,cAAc,EAAE,KAAK,EAQxB,CAAC;AAEX,eAAO,MAAM,qBAAqB,EAAE,YAAY,EAQtC,CAAC;AAEX,eAAO,MAAM,mBAAmB,EAAE,KAAK,EAQ7B,CAAC;AAEX,eAAO,MAAM,0BAA0B,EAAE,YAAY,EAQ3C,CAAC;AAEX,eAAO,MAAM,kBAAkB,EAAE,KAAK,EAQ5B,CAAC;AAEX,eAAO,MAAM,yBAAyB,EAAE,YAAY,EAQ1C,CAAC;AAEX,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,EAQhD,CAAC;AAEX,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,EAQhD,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/src/data/chords/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,YAAY,EACZ,KAAK,EACL,qBAAqB,EACtB,MAAM,oBAAoB,CAAC;AAE5B,+FAA+F;AAC/F,eAAO,MAAM,cAAc,EAAE,KAAK,EAQxB,CAAC;AAEX,uGAAuG;AACvG,eAAO,MAAM,qBAAqB,EAAE,YAAY,EAQtC,CAAC;AAEX,+FAA+F;AAC/F,eAAO,MAAM,mBAAmB,EAAE,KAAK,EAQ7B,CAAC;AAEX,uGAAuG;AACvG,eAAO,MAAM,0BAA0B,EAAE,YAAY,EAQ3C,CAAC;AAEX,8FAA8F;AAC9F,eAAO,MAAM,kBAAkB,EAAE,KAAK,EAQ5B,CAAC;AAEX,sGAAsG;AACtG,eAAO,MAAM,yBAAyB,EAAE,YAAY,EAQ1C,CAAC;AAEX,+FAA+F;AAC/F,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,EAQhD,CAAC;AAEX,+FAA+F;AAC/F,eAAO,MAAM,sBAAsB,EAAE,qBAAqB,EAQhD,CAAC"}

package/esm/src/data/chords/mod.js

@@ -1,3 +1,4 @@
+/** An ordered array containing the fundamental triad qualities of the diatonic major scale. */
 export const diatonicTriads = [
     "M",
     "m",
@@ -7,6 +8,7 @@ export const diatonicTriads = [
     "m",
     "°",
 ];
+/** An ordered array containing the fundamental seventh-chord qualities of the diatonic major scale. */
 export const diatonicSeventhChords = [
     "M7",
     "m7",
@@ -16,6 +18,7 @@ export const diatonicSeventhChords = [
     "m7",
     "ø7",
 ];
+/** An ordered array containing the fundamental triad qualities of the harmonic minor scale. */
 export const harmonicMinorTriads = [
     "m",
     "°",
@@ -25,6 +28,7 @@ export const harmonicMinorTriads = [
     "M",
     "°",
 ];
+/** An ordered array containing the fundamental seventh-chord qualities of the harmonic minor scale. */
 export const harmonicMinorSeventhChords = [
     "m(M7)",
     "ø7",
@@ -34,6 +38,7 @@ export const harmonicMinorSeventhChords = [
     "M7",
     "°7",
 ];
+/** An ordered array containing the fundamental triad qualities of the melodic minor scale. */
 export const melodicMinorTriads = [
     "m",
     "m",
@@ -43,6 +48,7 @@ export const melodicMinorTriads = [
     "°",
     "°",
 ];
+/** An ordered array containing the fundamental seventh-chord qualities of the melodic minor scale. */
 export const melodicMinorSeventhChords = [
     "m(M7)",
     "m7",
@@ -52,6 +58,7 @@ export const melodicMinorSeventhChords = [
     "ø7",
     "ø7",
 ];
+/** An array mapping 7 index scale degrees to their corresponding upper-case Roman numerals. */
 export const upperCaseRomanNumerals = [
     "I",
     "II",
@@ -61,6 +68,7 @@ export const upperCaseRomanNumerals = [
     "VI",
     "VII",
 ];
+/** An array mapping 7 index scale degrees to their corresponding lower-case Roman numerals. */
 export const lowerCaseRomanNumerals = [
     "i",
     "ii",

package/esm/src/data/labels/note-label-collections.d.ts

@@ -1,3 +1,4 @@
+/** A fixed 12-element tuple of strings representing each note in the chromatic scale. */
 export type NoteLabelGroup = readonly [
     string,
     string,
@@ -12,6 +13,7 @@ export type NoteLabelGroup = readonly [
     string,
     string
 ];
+/** The data interface governing an entire collection array of 12 note labels. */
 export interface NoteLabelCollection {
     readonly name: string;
     readonly shortName: string;
@@ -19,18 +21,42 @@ export interface NoteLabelCollection {
     readonly labels: NoteLabelGroup;
 }
 declare const _noteLabelCollections: {
-    readonly flat: {
-        readonly name: "Flat Notes";
-        readonly shortName: "Flat";
+    readonly noteNamesFlat: {
+        readonly name: "Flat Note Names";
+        readonly shortName: "Flat Notes";
         readonly isRelative: false;
         readonly labels: readonly ["C", "D♭", "D", "E♭", "E", "F", "G♭", "G", "A♭", "A", "B♭", "B"];
     };
-    readonly sharp: {
-        readonly name: "Sharp Notes";
-        readonly shortName: "Sharp";
+    readonly noteNamesSharp: {
+        readonly name: "Sharp Note Names";
+        readonly shortName: "Sharp Notes";
         readonly isRelative: false;
         readonly labels: readonly ["C", "C♯", "D", "D♯", "E", "F", "F♯", "G", "G♯", "A", "A♯", "B"];
     };
+    readonly intervalsFlat: {
+        readonly name: "Flat Note Intervals";
+        readonly shortName: "Flat Intervals";
+        readonly isRelative: true;
+        readonly labels: readonly ["1", "♭2", "2", "♭3", "3", "4", "♭5", "5", "♭6", "6", "♭7", "7"];
+    };
+    readonly intervalsSharp: {
+        readonly name: "Sharp Note Intervals";
+        readonly shortName: "Sharp Intervals";
+        readonly isRelative: true;
+        readonly labels: readonly ["1", "♯1", "2", "♯2", "3", "4", "♯4", "5", "♯5", "6", "♯6", "7"];
+    };
+    readonly extensionsFlat: {
+        readonly name: "Flat Note Extensions";
+        readonly shortName: "Flat Extensions";
+        readonly isRelative: true;
+        readonly labels: readonly ["1", "♭9", "9", "♭3", "3", "11", "♭5", "5", "♭13", "13", "♭7", "7"];
+    };
+    readonly extensionsSharp: {
+        readonly name: "Sharp Note Extensions";
+        readonly shortName: "Sharp Extensions";
+        readonly isRelative: true;
+        readonly labels: readonly ["1", "♯1", "9", "♯9", "3", "11", "♯11", "5", "♯5", "13", "♯13", "7"];
+    };
     readonly fixedDoFlat: {
         readonly name: "Solfege Fixed Do Flat Notes";
         readonly shortName: "Fixed Do Flat";
@@ -56,7 +82,9 @@ declare const _noteLabelCollections: {
         readonly labels: readonly ["la", "te", "ti", "do", "di", "re", "re", "mi", "fa", "fi", "sol", "si"];
     };
 };
+/** A union string of valid keys to lookup different note label collections. */
 export type NoteLabelCollectionKey = keyof typeof _noteLabelCollections;
+/** A dictionary holding arrays mapping integer semitones into note/solfege names for varied contexts. */
 export declare const noteLabelCollections: Record<NoteLabelCollectionKey, NoteLabelCollection>;
 export {};
 //# sourceMappingURL=note-label-collections.d.ts.map

package/esm/src/data/labels/note-label-collections.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"note-label-collections.d.ts","sourceRoot":"","sources":["../../../../src/src/data/labels/note-label-collections.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,SAAS;IACpC,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;CACP,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;CACjC;AAED,QAAA,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8FjB,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,qBAAqB,CAAC;AAExE,eAAO,MAAM,oBAAoB,EAAE,MAAM,CACvC,sBAAsB,EACtB,mBAAmB,CACI,CAAC"}
+{"version":3,"file":"note-label-collections.d.ts","sourceRoot":"","sources":["../../../../src/src/data/labels/note-label-collections.ts"],"names":[],"mappings":"AAAA,yFAAyF;AACzF,MAAM,MAAM,cAAc,GAAG,SAAS;IACpC,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;CACP,CAAC;AAEF,iFAAiF;AACjF,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;CACjC;AAED,QAAA,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoJjB,CAAC;AAEX,+EAA+E;AAC/E,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,qBAAqB,CAAC;AAExE,yGAAyG;AACzG,eAAO,MAAM,oBAAoB,EAAE,MAAM,CACvC,sBAAsB,EACtB,mBAAmB,CACI,CAAC"}

package/esm/src/data/labels/note-label-collections.js

@@ -1,16 +1,66 @@
 const _noteLabelCollections = {
-    flat: {
-        name: "Flat Notes",
-        shortName: "Flat",
+    noteNamesFlat: {
+        name: "Flat Note Names",
+        shortName: "Flat Notes",
         isRelative: false,
         labels: ["C", "D♭", "D", "E♭", "E", "F", "G♭", "G", "A♭", "A", "B♭", "B"],
     },
-    sharp: {
-        name: "Sharp Notes",
-        shortName: "Sharp",
+    noteNamesSharp: {
+        name: "Sharp Note Names",
+        shortName: "Sharp Notes",
         isRelative: false,
         labels: ["C", "C♯", "D", "D♯", "E", "F", "F♯", "G", "G♯", "A", "A♯", "B"],
     },
+    intervalsFlat: {
+        name: "Flat Note Intervals",
+        shortName: "Flat Intervals",
+        isRelative: true,
+        labels: ["1", "♭2", "2", "♭3", "3", "4", "♭5", "5", "♭6", "6", "♭7", "7"],
+    },
+    intervalsSharp: {
+        name: "Sharp Note Intervals",
+        shortName: "Sharp Intervals",
+        isRelative: true,
+        labels: ["1", "♯1", "2", "♯2", "3", "4", "♯4", "5", "♯5", "6", "♯6", "7"],
+    },
+    extensionsFlat: {
+        name: "Flat Note Extensions",
+        shortName: "Flat Extensions",
+        isRelative: true,
+        labels: [
+            "1",
+            "♭9",
+            "9",
+            "♭3",
+            "3",
+            "11",
+            "♭5",
+            "5",
+            "♭13",
+            "13",
+            "♭7",
+            "7",
+        ],
+    },
+    extensionsSharp: {
+        name: "Sharp Note Extensions",
+        shortName: "Sharp Extensions",
+        isRelative: true,
+        labels: [
+            "1",
+            "♯1",
+            "9",
+            "♯9",
+            "3",
+            "11",
+            "♯11",
+            "5",
+            "♯5",
+            "13",
+            "♯13",
+            "7",
+        ],
+    },
     fixedDoFlat: {
         name: "Solfege Fixed Do Flat Notes",
         shortName: "Fixed Do Flat",
@@ -88,4 +138,5 @@ const _noteLabelCollections = {
         ],
     },
 };
+/** A dictionary holding arrays mapping integer semitones into note/solfege names for varied contexts. */
 export const noteLabelCollections = _noteLabelCollections;

package/esm/src/data/labels/note-labels.d.ts

@@ -1,6 +1,9 @@
+/** Represents the mathematical zero-indexed pitch class of a root note, where C is 0 and B is 11. */
 export type RootNoteInteger = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
 declare const _noteLetters: readonly ["C", "D", "E", "F", "G", "A", "B"];
+/** An alphabetical musical note letter without any accidentals. */
 export type NoteLetter = (typeof _noteLetters)[number];
+/** An ordered array of the seven fundamental note letters (C through B). */
 export declare const noteLetters: readonly NoteLetter[];
 declare const _noteAccidentalToIntegerMap: {
     readonly "\uD834\uDD2B": -2;
@@ -9,20 +12,33 @@ declare const _noteAccidentalToIntegerMap: {
     readonly "\u266F": 1;
     readonly "\uD834\uDD2A": 2;
 };
+/** Valid musical accidental symbols, including double flats and double sharps. */
 export type NoteAccidental = keyof typeof _noteAccidentalToIntegerMap;
+/** A mapping of an accidental symbol to its numeric semitone alteration (-2 to +2). */
 export declare const noteAccidentalToIntegerMap: ReadonlyMap<NoteAccidental, number>;
 declare const _enharmonicNoteNameGroups: readonly [readonly ["C", "C♮", "B♯", "D𝄫"], readonly ["D♭", "C♯", "B𝄪"], readonly ["D", "D♮", "E𝄫", "C𝄪"], readonly ["E♭", "D♯", "F𝄫"], readonly ["E", "E♮", "F♭", "D𝄪"], readonly ["F", "F♮", "E♯", "G𝄫"], readonly ["G♭", "F♯", "E𝄪"], readonly ["G", "G♮", "A𝄫", "F𝄪"], readonly ["A♭", "G♯"], readonly ["A", "A♮", "B𝄫", "G𝄪"], readonly ["B♭", "A♯", "C𝄫"], readonly ["B", "B♮", "C♭", "A𝄪"]];
+/** A fully qualified note name string, consisting of a note letter and optional accidentals. */
 export type NoteName = (typeof _enharmonicNoteNameGroups)[number][number];
+/** A two-dimensional array grouping note names that are enharmonically equivalent (e.g., C♯ and D♭). */
 export declare const enharmonicNoteNameGroups: readonly (readonly NoteName[])[];
+/** A flat list of every possible valid note name. */
 export declare const noteNames: readonly NoteName[];
+/** A Set of every possible valid note name, optimized for quick existence checks. */
 export declare const noteNamesSet: ReadonlySet<NoteName>;
+/** A mapping from a fully qualified note name string to its underlying 0-11 integer representation. */
 export declare const noteNameToIntegerMap: ReadonlyMap<NoteName, RootNoteInteger>;
 declare const _enharmonicRootNoteGroups: readonly [readonly ["C", "B♯"], readonly ["D♭", "C♯"], readonly ["D"], readonly ["E♭", "D♯"], readonly ["E", "F♭"], readonly ["F", "E♯"], readonly ["G♭", "F♯"], readonly ["G"], readonly ["A♭", "G♯"], readonly ["A"], readonly ["B♭", "A♯"], readonly ["B", "C♭"]];
+/** A restricted subset of note names that are practically viable to be used as musical root notes. */
 export type RootNote = (typeof _enharmonicRootNoteGroups)[number][number];
+/** A two-dimensional array grouping viable root notes by their enharmonic equivalence. */
 export declare const enharmonicRootNoteGroups: readonly (readonly RootNote[])[];
+/** A flat list of every viable root note. */
 export declare const rootNotes: readonly RootNote[];
+/** A Set of every viable root note, optimized for quick existence checks. */
 export declare const rootNotesSet: ReadonlySet<RootNote>;
+/** A mapping from a viable root note string to its underlying 0-11 integer representation. */
 export declare const rootNoteToIntegerMap: ReadonlyMap<RootNote, RootNoteInteger>;
+/** A numeric string representing the numerical span of a simple interval (e.g. "3", "7"). */
 export type SimpleIntervalNumber = "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8";
 declare const _simpleIntervalToIntegerMap: {
     readonly "\uD834\uDD2B1": -2;
@@ -74,7 +90,9 @@ declare const _simpleIntervalToIntegerMap: {
     readonly "\u266F8": 13;
     readonly "\uD834\uDD2A8": 14;
 };
+/** A fully qualified simple (single octave) interval string, including an optional accidental symbol (e.g., "M3", "b7"). */
 export type SimpleInterval = keyof typeof _simpleIntervalToIntegerMap;
+/** A numeric string representing the numerical span of a compound interval (e.g. "9", "13"). */
 export type CompoundIntervalNumber = "9" | "10" | "11" | "12" | "13" | "14" | "15";
 declare const _compoundIntervalToIntegerMap: {
     readonly "\uD834\uDD2B9": 12;
@@ -120,7 +138,9 @@ declare const _compoundIntervalToIntegerMap: {
     readonly "\u266F15": 25;
     readonly "\uD834\uDD2A15": 26;
 };
+/** A fully qualified compound (multi-octave) interval string (e.g., "b9", "#11"). */
 export type CompoundInterval = keyof typeof _compoundIntervalToIntegerMap;
+/** An interval number ignoring any quality or accidentals, and can be simple or compound. */
 export type IntervalNumber = SimpleIntervalNumber | CompoundIntervalNumber;
 declare const _intervalToIntegerMap: {
     readonly "\uD834\uDD2B9": 12;
@@ -214,12 +234,19 @@ declare const _intervalToIntegerMap: {
     readonly "\u266F8": 13;
     readonly "\uD834\uDD2A8": 14;
 };
+/** A fully qualified simple or compound interval string. */
 export type Interval = keyof typeof _intervalToIntegerMap;
+/** A mapping to convert any Interval string into its integer semitone offset. */
 export declare const intervalToIntegerMap: ReadonlyMap<Interval, number>;
+/** A mapping converting applicable simple intervals into equivalent extended intervals (e.g., "2" -> "9"). */
 export declare const simpleToExtensionIntervalMap: ReadonlyMap<SimpleInterval, CompoundInterval>;
+/** A mapping converting applicable extended intervals back out into simple intervals (e.g., "9" -> "2"). */
 export declare const extensionToSimpleIntervalMap: ReadonlyMap<CompoundInterval, SimpleInterval>;
+/** A rigorous mapping converting *all* simple intervals into compound intervals via adding a pure octave. */
 export declare const simpleToCompoundIntervalMap: ReadonlyMap<SimpleInterval, CompoundInterval>;
+/** A rigorous mapping converting *all* compound intervals into simple intervals via subtracting a pure octave. */
 export declare const compoundToSimpleIntervalMap: ReadonlyMap<CompoundInterval, SimpleInterval>;
+/** The alphabetical descriptor of an interval's harmonic quality (e.g., major 'M', minor 'm', perfect 'P'). */
 export type IntervalQualityType = "dd" | "d" | "m" | "P" | "M" | "A" | "AA";
 declare const _intervalQualityToIntegerMap: {
     readonly dd1: -2;
@@ -306,9 +333,13 @@ declare const _intervalQualityToIntegerMap: {
     readonly A15: 25;
     readonly AA15: 26;
 };
+/** An interval represented explicitly by its harmonic quality prefix rather than accidentals (e.g. 'M3' instead of '♮3'). */
 export type IntervalQuality = keyof typeof _intervalQualityToIntegerMap;
+/** Maps an interval quality explicitly to its numerical integer semitone offset. */
 export declare const intervalQualityToIntegerMap: ReadonlyMap<IntervalQuality, number>;
+/** Maps a generic, potentially accidental-defined interval to its proper harmonic `IntervalQuality`. */
 export declare const intervalToIntervalQualityMap: ReadonlyMap<Interval, IntervalQuality>;
+/** Maps a strict interval quality identifier back into its accidental-defined `Interval` string equivalent. */
 export declare const intervalQualityToIntervalMap: ReadonlyMap<IntervalQuality, Interval>;
 export {};
 //# sourceMappingURL=note-labels.d.ts.map

package/esm/src/data/labels/note-labels.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"note-labels.d.ts","sourceRoot":"","sources":["../../../../src/src/data/labels/note-labels.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;AAE9E,QAAA,MAAM,YAAY,8CAA+C,CAAC;AAElE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,eAAO,MAAM,WAAW,EAAE,SAAS,UAAU,EAAiB,CAAC;AAE/D,QAAA,MAAM,2BAA2B;;;;;;CAMvB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,2BAA2B,CAAC;AAEtE,eAAO,MAAM,0BAA0B,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,CAGxE,CAAC;AAEJ,QAAA,MAAM,yBAAyB,kZAarB,CAAC;AAEX,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,eAAO,MAAM,wBAAwB,EAAE,SAAS,CAAC,SAAS,QAAQ,EAAE,CAAC,EAC1C,CAAC;AAE5B,eAAO,MAAM,SAAS,EAAE,SAAS,QAAQ,EAAoC,CAAC;AAE9E,eAAO,MAAM,YAAY,EAAE,WAAW,CAAC,QAAQ,CAAsB,CAAC;AAEtE,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,QAAQ,EAAE,eAAe,CASlE,CAAC;AAEP,QAAA,MAAM,yBAAyB,sQAarB,CAAC;AAEX,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,eAAO,MAAM,wBAAwB,EAAE,SAAS,CAAC,SAAS,QAAQ,EAAE,CAAC,EAC1C,CAAC;AAE5B,eAAO,MAAM,SAAS,EAAE,SAAS,QAAQ,EAAoC,CAAC;AAE9E,eAAO,MAAM,YAAY,EAAE,WAAW,CAAC,QAAQ,CAAsB,CAAC;AAEtE,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,QAAQ,EAAE,eAAe,CASlE,CAAC;AAEP,MAAM,MAAM,oBAAoB,GAC5B,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAC;AAER,QAAA,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwDvB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,2BAA2B,CAAC;AAEtE,MAAM,MAAM,sBAAsB,GAC9B,GAAG,GACH,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;AAET,QAAA,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiDzB,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,MAAM,OAAO,6BAA6B,CAAC;AAE1E,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG,sBAAsB,CAAC;AAE3E,QAAA,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGjB,CAAC;AAEX,MAAM,MAAM,QAAQ,GAAG,MAAM,OAAO,qBAAqB,CAAC;AAE1D,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,QAAQ,EAAE,MAAM,CAE9D,CAAC;AAiBF,eAAO,MAAM,4BAA4B,EAAE,WAAW,CACpD,cAAc,EACd,gBAAgB,CAMjB,CAAC;AAiBF,eAAO,MAAM,4BAA4B,EAAE,WAAW,CACpD,gBAAgB,EAChB,cAAc,CAMf,CAAC;AA6BF,eAAO,MAAM,2BAA2B,EAAE,WAAW,CACnD,cAAc,EACd,gBAAgB,CAMjB,CAAC;AA6BF,eAAO,MAAM,2BAA2B,EAAE,WAAW,CACnD,gBAAgB,EAChB,cAAc,CAMf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC;AAE5E,QAAA,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkGxB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,4BAA4B,CAAC;AAExE,eAAO,MAAM,2BAA2B,EAAE,WAAW,CAAC,eAAe,EAAE,MAAM,CAG1E,CAAC;AA6GJ,eAAO,MAAM,4BAA4B,EAAE,WAAW,CACpD,QAAQ,EACR,eAAe,CAMhB,CAAC;AA8FF,eAAO,MAAM,4BAA4B,EAAE,WAAW,CACpD,eAAe,EACf,QAAQ,CAMT,CAAC"}
+{"version":3,"file":"note-labels.d.ts","sourceRoot":"","sources":["../../../../src/src/data/labels/note-labels.ts"],"names":[],"mappings":"AAAA,qGAAqG;AACrG,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;AAE9E,QAAA,MAAM,YAAY,8CAA+C,CAAC;AAElE,mEAAmE;AACnE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,4EAA4E;AAC5E,eAAO,MAAM,WAAW,EAAE,SAAS,UAAU,EAAiB,CAAC;AAE/D,QAAA,MAAM,2BAA2B;;;;;;CAMvB,CAAC;AAEX,kFAAkF;AAClF,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,2BAA2B,CAAC;AAEtE,uFAAuF;AACvF,eAAO,MAAM,0BAA0B,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,CAGxE,CAAC;AAEJ,QAAA,MAAM,yBAAyB,kZAarB,CAAC;AAEX,gGAAgG;AAChG,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,wGAAwG;AACxG,eAAO,MAAM,wBAAwB,EAAE,SAAS,CAAC,SAAS,QAAQ,EAAE,CAAC,EAC1C,CAAC;AAE5B,qDAAqD;AACrD,eAAO,MAAM,SAAS,EAAE,SAAS,QAAQ,EAAoC,CAAC;AAE9E,qFAAqF;AACrF,eAAO,MAAM,YAAY,EAAE,WAAW,CAAC,QAAQ,CAAsB,CAAC;AAEtE,uGAAuG;AACvG,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,QAAQ,EAAE,eAAe,CASlE,CAAC;AAEP,QAAA,MAAM,yBAAyB,sQAarB,CAAC;AAEX,sGAAsG;AACtG,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,0FAA0F;AAC1F,eAAO,MAAM,wBAAwB,EAAE,SAAS,CAAC,SAAS,QAAQ,EAAE,CAAC,EAC1C,CAAC;AAE5B,6CAA6C;AAC7C,eAAO,MAAM,SAAS,EAAE,SAAS,QAAQ,EAAoC,CAAC;AAE9E,6EAA6E;AAC7E,eAAO,MAAM,YAAY,EAAE,WAAW,CAAC,QAAQ,CAAsB,CAAC;AAEtE,8FAA8F;AAC9F,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,QAAQ,EAAE,eAAe,CASlE,CAAC;AAEP,6FAA6F;AAC7F,MAAM,MAAM,oBAAoB,GAC5B,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAC;AAER,QAAA,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwDvB,CAAC;AAEX,4HAA4H;AAC5H,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,2BAA2B,CAAC;AAEtE,gGAAgG;AAChG,MAAM,MAAM,sBAAsB,GAC9B,GAAG,GACH,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;AAET,QAAA,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiDzB,CAAC;AAEX,qFAAqF;AACrF,MAAM,MAAM,gBAAgB,GAAG,MAAM,OAAO,6BAA6B,CAAC;AAE1E,6FAA6F;AAC7F,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG,sBAAsB,CAAC;AAE3E,QAAA,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGjB,CAAC;AAEX,4DAA4D;AAC5D,MAAM,MAAM,QAAQ,GAAG,MAAM,OAAO,qBAAqB,CAAC;AAE1D,iFAAiF;AACjF,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,QAAQ,EAAE,MAAM,CAE9D,CAAC;AAiBF,8GAA8G;AAC9G,eAAO,MAAM,4BAA4B,EAAE,WAAW,CACpD,cAAc,EACd,gBAAgB,CAMjB,CAAC;AAiBF,4GAA4G;AAC5G,eAAO,MAAM,4BAA4B,EAAE,WAAW,CACpD,gBAAgB,EAChB,cAAc,CAMf,CAAC;AA6BF,6GAA6G;AAC7G,eAAO,MAAM,2BAA2B,EAAE,WAAW,CACnD,cAAc,EACd,gBAAgB,CAMjB,CAAC;AA6BF,kHAAkH;AAClH,eAAO,MAAM,2BAA2B,EAAE,WAAW,CACnD,gBAAgB,EAChB,cAAc,CAMf,CAAC;AAEF,+GAA+G;AAC/G,MAAM,MAAM,mBAAmB,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC;AAE5E,QAAA,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkGxB,CAAC;AAEX,6HAA6H;AAC7H,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,4BAA4B,CAAC;AAExE,oFAAoF;AACpF,eAAO,MAAM,2BAA2B,EAAE,WAAW,CAAC,eAAe,EAAE,MAAM,CAG1E,CAAC;AA6GJ,wGAAwG;AACxG,eAAO,MAAM,4BAA4B,EAAE,WAAW,CACpD,QAAQ,EACR,eAAe,CAMhB,CAAC;AA8FF,+GAA+G;AAC/G,eAAO,MAAM,4BAA4B,EAAE,WAAW,CACpD,eAAe,EACf,QAAQ,CAMT,CAAC"}

package/esm/src/data/labels/note-labels.js

@@ -1,4 +1,5 @@
 const _noteLetters = ["C", "D", "E", "F", "G", "A", "B"];
+/** An ordered array of the seven fundamental note letters (C through B). */
 export const noteLetters = _noteLetters;
 const _noteAccidentalToIntegerMap = {
     "𝄫": -2,
@@ -7,6 +8,7 @@ const _noteAccidentalToIntegerMap = {
     "♯": 1,
     "𝄪": 2,
 };
+/** A mapping of an accidental symbol to its numeric semitone alteration (-2 to +2). */
 export const noteAccidentalToIntegerMap = new Map(Object.entries(_noteAccidentalToIntegerMap));
 const _enharmonicNoteNameGroups = [
     ["C", "C♮", "B♯", "D𝄫"],
@@ -22,9 +24,13 @@ const _enharmonicNoteNameGroups = [
     ["B♭", "A♯", "C𝄫"],
     ["B", "B♮", "C♭", "A𝄪"],
 ];
+/** A two-dimensional array grouping note names that are enharmonically equivalent (e.g., C♯ and D♭). */
 export const enharmonicNoteNameGroups = _enharmonicNoteNameGroups;
+/** A flat list of every possible valid note name. */
 export const noteNames = enharmonicNoteNameGroups.flat();
+/** A Set of every possible valid note name, optimized for quick existence checks. */
 export const noteNamesSet = new Set(noteNames);
+/** A mapping from a fully qualified note name string to its underlying 0-11 integer representation. */
 export const noteNameToIntegerMap = (() => {
     const map = new Map();
     _enharmonicNoteNameGroups.forEach((group, index) => {
@@ -48,9 +54,13 @@ const _enharmonicRootNoteGroups = [
     ["B♭", "A♯"],
     ["B", "C♭"],
 ];
+/** A two-dimensional array grouping viable root notes by their enharmonic equivalence. */
 export const enharmonicRootNoteGroups = _enharmonicRootNoteGroups;
+/** A flat list of every viable root note. */
 export const rootNotes = enharmonicRootNoteGroups.flat();
+/** A Set of every viable root note, optimized for quick existence checks. */
 export const rootNotesSet = new Set(rootNotes);
+/** A mapping from a viable root note string to its underlying 0-11 integer representation. */
 export const rootNoteToIntegerMap = (() => {
     const map = new Map();
     enharmonicRootNoteGroups.forEach((group, index) => {
@@ -158,6 +168,7 @@ const _intervalToIntegerMap = {
     ..._simpleIntervalToIntegerMap,
     ..._compoundIntervalToIntegerMap,
 };
+/** A mapping to convert any Interval string into its integer semitone offset. */
 export const intervalToIntegerMap = new Map(Object.entries(_intervalToIntegerMap));
 const _simpleToExtensionIntervalMap = {
     "2": "9",
@@ -173,6 +184,7 @@ const _simpleToExtensionIntervalMap = {
     "♭6": "♭13",
     "♯6": "♯13",
 };
+/** A mapping converting applicable simple intervals into equivalent extended intervals (e.g., "2" -> "9"). */
 export const simpleToExtensionIntervalMap = new Map(Object.entries(_simpleToExtensionIntervalMap));
 const _extensionToSimpleIntervalMap = {
     "9": "2",
@@ -188,6 +200,7 @@ const _extensionToSimpleIntervalMap = {
     "♭13": "♭6",
     "♯13": "♯6",
 };
+/** A mapping converting applicable extended intervals back out into simple intervals (e.g., "9" -> "2"). */
 export const extensionToSimpleIntervalMap = new Map(Object.entries(_extensionToSimpleIntervalMap));
 const _simpleToCompoundIntervalMap = {
     "2": "9",
@@ -215,6 +228,7 @@ const _simpleToCompoundIntervalMap = {
     "♭7": "♭14",
     "♯7": "♯14",
 };
+/** A rigorous mapping converting *all* simple intervals into compound intervals via adding a pure octave. */
 export const simpleToCompoundIntervalMap = new Map(Object.entries(_simpleToCompoundIntervalMap));
 const _compoundToSimpleIntervalMap = {
     "9": "2",
@@ -242,6 +256,7 @@ const _compoundToSimpleIntervalMap = {
     "♭14": "♭7",
     "♯14": "♯7",
 };
+/** A rigorous mapping converting *all* compound intervals into simple intervals via subtracting a pure octave. */
 export const compoundToSimpleIntervalMap = new Map(Object.entries(_compoundToSimpleIntervalMap));
 const _intervalQualityToIntegerMap = {
     dd1: -2,
@@ -328,6 +343,7 @@ const _intervalQualityToIntegerMap = {
     A15: 25,
     AA15: 26,
 };
+/** Maps an interval quality explicitly to its numerical integer semitone offset. */
 export const intervalQualityToIntegerMap = new Map(Object.entries(_intervalQualityToIntegerMap));
 const _intervalToIntervalQualityMap = {
     "𝄫1": "dd1",
@@ -421,6 +437,7 @@ const _intervalToIntervalQualityMap = {
     "♯15": "A15",
     "𝄪15": "AA15",
 };
+/** Maps a generic, potentially accidental-defined interval to its proper harmonic `IntervalQuality`. */
 export const intervalToIntervalQualityMap = new Map(Object.entries(_intervalToIntervalQualityMap));
 const _intervalQualityToIntervalMap = {
     dd1: "𝄫1",
@@ -499,4 +516,5 @@ const _intervalQualityToIntervalMap = {
     A15: "♯15",
     AA15: "𝄪15",
 };
+/** Maps a strict interval quality identifier back into its accidental-defined `Interval` string equivalent. */
 export const intervalQualityToIntervalMap = new Map(Object.entries(_intervalQualityToIntervalMap));

package/esm/src/data/note-collections/diatonic-modes.d.ts

@@ -8,7 +8,9 @@ declare const _diatonicModes: {
     readonly aeolian: ModalScaleCollection;
     readonly locrian: ModalScaleCollection;
 };
+/** A strictly typed generic string representing the key of any diatonic mode. */
 export type DiatonicModeKey = keyof typeof _diatonicModes;
+/** A dictionary storing all 7 fundamental modes of the diatonic major scale. */
 export declare const diatonicModes: Record<DiatonicModeKey, ModalScaleCollection>;
 export {};
 //# sourceMappingURL=diatonic-modes.d.ts.map

package/esm/src/data/note-collections/diatonic-modes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"diatonic-modes.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/diatonic-modes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AA2PzE,QAAA,MAAM,cAAc;;;;;;;;CAQV,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,cAAc,CAAC;AAE1D,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,eAAe,EAAE,oBAAoB,CACxD,CAAC"}
+{"version":3,"file":"diatonic-modes.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/diatonic-modes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AA2PzE,QAAA,MAAM,cAAc;;;;;;;;CAQV,CAAC;AAEX,iFAAiF;AACjF,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,cAAc,CAAC;AAE1D,gFAAgF;AAChF,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,eAAe,EAAE,oBAAoB,CACxD,CAAC"}

package/esm/src/data/note-collections/diatonic-modes.js

@@ -249,4 +249,5 @@ const _diatonicModes = {
     aeolian,
     locrian,
 };
+/** A dictionary storing all 7 fundamental modes of the diatonic major scale. */
 export const diatonicModes = _diatonicModes;

package/esm/src/data/note-collections/harmonic-minor-modes.d.ts

@@ -8,6 +8,8 @@ export declare const _harmonicMinorModes: {
     readonly lydianSharp2: ModalScaleCollection;
     readonly superLocrianDoubleFlat7: ModalScaleCollection;
 };
+/** A strictly typed generic string representing the key of any harmonic minor mode. */
 export type HarmonicMinorModeKey = keyof typeof _harmonicMinorModes;
+/** A dictionary storing all 7 fundamental modes of the harmonic minor scale. */
 export declare const harmonicMinorModes: Record<HarmonicMinorModeKey, ModalScaleCollection>;
 //# sourceMappingURL=harmonic-minor-modes.d.ts.map

package/esm/src/data/note-collections/harmonic-minor-modes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"harmonic-minor-modes.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/harmonic-minor-modes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AA4PzE,eAAO,MAAM,mBAAmB;;;;;;;;CAQtB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAEpE,eAAO,MAAM,kBAAkB,EAAE,MAAM,CACrC,oBAAoB,EACpB,oBAAoB,CACC,CAAC"}
+{"version":3,"file":"harmonic-minor-modes.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/harmonic-minor-modes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AA4PzE,eAAO,MAAM,mBAAmB;;;;;;;;CAQtB,CAAC;AAEX,uFAAuF;AACvF,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAEpE,gFAAgF;AAChF,eAAO,MAAM,kBAAkB,EAAE,MAAM,CACrC,oBAAoB,EACpB,oBAAoB,CACC,CAAC"}

package/esm/src/data/note-collections/harmonic-minor-modes.js

@@ -250,4 +250,5 @@ export const _harmonicMinorModes = {
     lydianSharp2,
     superLocrianDoubleFlat7,
 };
+/** A dictionary storing all 7 fundamental modes of the harmonic minor scale. */
 export const harmonicMinorModes = _harmonicMinorModes;

package/esm/src/data/note-collections/melodic-minor-modes.d.ts

@@ -8,6 +8,8 @@ export declare const _melodicMinorModes: {
     readonly aeolianFlat5: ModalScaleCollection;
     readonly altered: ModalScaleCollection;
 };
+/** A strictly typed generic string representing the key of any melodic minor mode. */
 export type MelodicMinorModeKey = keyof typeof _melodicMinorModes;
+/** A dictionary storing all 7 fundamental modes of the melodic minor scale. */
 export declare const melodicMinorModes: Record<MelodicMinorModeKey, ModalScaleCollection>;
 //# sourceMappingURL=melodic-minor-modes.d.ts.map

package/esm/src/data/note-collections/melodic-minor-modes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"melodic-minor-modes.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/melodic-minor-modes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AA8MzE,eAAO,MAAM,kBAAkB;;;;;;;;CAQrB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,kBAAkB,CAAC;AAElE,eAAO,MAAM,iBAAiB,EAAE,MAAM,CACpC,mBAAmB,EACnB,oBAAoB,CACA,CAAC"}
+{"version":3,"file":"melodic-minor-modes.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/melodic-minor-modes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AA8MzE,eAAO,MAAM,kBAAkB;;;;;;;;CAQrB,CAAC;AAEX,sFAAsF;AACtF,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,kBAAkB,CAAC;AAElE,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB,EAAE,MAAM,CACpC,mBAAmB,EACnB,oBAAoB,CACA,CAAC"}

package/esm/src/data/note-collections/melodic-minor-modes.js

@@ -204,4 +204,5 @@ export const _melodicMinorModes = {
     aeolianFlat5,
     altered,
 };
+/** A dictionary storing all 7 fundamental modes of the melodic minor scale. */
 export const melodicMinorModes = _melodicMinorModes;

package/esm/src/data/note-collections/mod.d.ts

@@ -8,6 +8,7 @@ export { melodicMinorModes } from "./melodic-minor-modes.js";
 export { diminishedVariants } from "./diminished-variants.js";
 export { augmentedVariants } from "./augmented-variants.js";
 export { otherNoteCollections } from "./other-collections.js";
+/** A massive, flattened dictionary of every pre-defined musical scale, mode, chord, and arpeggio inside the library. */
 export declare const noteCollections: {
     readonly rootAndFifth: import("../../mod.js").NoteCollection;
     readonly bluesPentatonic: import("../../mod.js").NoteCollection;
@@ -65,7 +66,9 @@ export declare const noteCollections: {
     readonly aeolian: import("../../mod.js").ModalScaleCollection;
     readonly locrian: import("../../mod.js").ModalScaleCollection;
 };
+/** A strictly typed generic string representing any key corresponding to a NoteCollection loaded in `noteCollections`. */
 export type NoteCollectionKey = keyof typeof noteCollections;
+/** An organized, grouped dictionary splitting note collections into theoretical categories (e.g. Diatonic Modes, Major Variants). */
 export declare const groupedNoteCollections: {
     readonly diatonicModes: Record<"ionian" | "dorian" | "phrygian" | "lydian" | "mixolydian" | "aeolian" | "locrian", import("../../mod.js").ModalScaleCollection>;
     readonly pentatonicVariants: Record<"majorPentatonic" | "suspendedPentatonic" | "bluesMinorPentatonic" | "bluesMajorPentatonic" | "minorPentatonic", import("../../mod.js").ModalScaleCollection>;
@@ -78,7 +81,9 @@ export declare const groupedNoteCollections: {
     readonly augmentedVariants: Record<"augmentedTriad" | "augmented7", import("../../mod.js").ChordCollection>;
     readonly otherNoteCollections: Record<"rootAndFifth" | "bluesPentatonic" | "chromatic" | "wholeTone", import("../../mod.js").NoteCollection>;
 };
+/** A strictly typed generic string representing the key of a top-level note collection category array. */
 export type NoteCollectionGroupKey = keyof typeof groupedNoteCollections;
+/** Human-readable DisplayName and Description metadata representing the mathematical traits of a Collection Group. */
 export declare const noteCollectionGroupsMetadata: Record<NoteCollectionGroupKey, {
     displayName: string;
     description: string;

package/esm/src/data/note-collections/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/mod.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWlB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,eAAe,CAAC;AAE7D,eAAO,MAAM,sBAAsB;;;;;;;;;;;CAWzB,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,sBAAsB,CAAC;AAEzE,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAC/C,sBAAsB,EACtB;IACE,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,CAkDO,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/mod.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,wHAAwH;AACxH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWlB,CAAC;AAEX,0HAA0H;AAC1H,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,eAAe,CAAC;AAE7D,qIAAqI;AACrI,eAAO,MAAM,sBAAsB;;;;;;;;;;;CAWzB,CAAC;AAEX,0GAA0G;AAC1G,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,sBAAsB,CAAC;AAEzE,sHAAsH;AACtH,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAC/C,sBAAsB,EACtB;IACE,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,CAkDO,CAAC"}

package/esm/src/data/note-collections/mod.js

@@ -18,6 +18,7 @@ export { melodicMinorModes } from "./melodic-minor-modes.js";
 export { diminishedVariants } from "./diminished-variants.js";
 export { augmentedVariants } from "./augmented-variants.js";
 export { otherNoteCollections } from "./other-collections.js";
+/** A massive, flattened dictionary of every pre-defined musical scale, mode, chord, and arpeggio inside the library. */
 export const noteCollections = {
     ...diatonicModes,
     ...pentatonicVariants,
@@ -30,6 +31,7 @@ export const noteCollections = {
     ...augmentedVariants,
     ...otherNoteCollections,
 };
+/** An organized, grouped dictionary splitting note collections into theoretical categories (e.g. Diatonic Modes, Major Variants). */
 export const groupedNoteCollections = {
     diatonicModes,
     pentatonicVariants,
@@ -42,6 +44,7 @@ export const groupedNoteCollections = {
     augmentedVariants,
     otherNoteCollections,
 };
+/** Human-readable DisplayName and Description metadata representing the mathematical traits of a Collection Group. */
 export const noteCollectionGroupsMetadata = {
     diatonicModes: {
         displayName: "Diatonic Modes",