@musodojo/music-theory-data 18.0.0 → 19.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@musodojo/music-theory-data",
-  "version": "18.0.0",
+  "version": "19.0.1",
   "description": "The musician-friendly TypeScript library for modes, scales, chords, and more.",
   "keywords": [
     "music",

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

@@ -1,12 +1,9 @@
-import type {
-  ModalScaleCollection,
-  ParentScaleCollection,
-  ScaleCollection,
-} from "../../types/note-collections.d.ts";
+import type { ModalScaleCollection } from "../../types/note-collections.d.ts";
 
-const ionian: ParentScaleCollection = {
+const ionian: ModalScaleCollection = {
   category: "scale",
   rotation: 0,
+  parentScale: "ionian",
   primaryName: "Major",
   names: [
     "Major",
@@ -280,5 +277,5 @@ const _diatonicModes = {
 
 export type DiatonicModeKey = keyof typeof _diatonicModes;
 
-export const diatonicModes: Record<DiatonicModeKey, ScaleCollection> =
+export const diatonicModes: Record<DiatonicModeKey, ModalScaleCollection> =
   _diatonicModes;

package/src/data/note-collections/diminished-variants.ts

@@ -2,7 +2,6 @@ import type {
   ChordCollection,
   ModalScaleCollection,
   NoteCollection,
-  ParentScaleCollection,
 } from "../../types/note-collections.d.ts";
 
 const diminishedTriad: ChordCollection = {
@@ -41,9 +40,10 @@ const halfDiminished7: ChordCollection = {
   patternShort: ["m3", "m3", "M3"],
 } as const;
 
-const wholeHalfDiminished: ParentScaleCollection = {
+const wholeHalfDiminished: ModalScaleCollection = {
   category: "scale",
   rotation: 0,
+  parentScale: "wholeHalfDiminished",
   primaryName: "Whole Half Diminished",
   names: ["Whole Half Diminished"],
   intervals: ["1", "2", "♭3", "4", "♭5", "♭6", "6", "7", "8"],

package/src/data/note-collections/dominant-variants.ts

@@ -1,7 +1,7 @@
 import type {
   ChordCollection,
+  NonModalScaleCollection,
   NoteCollection,
-  ScaleCollection,
 } from "../../types/note-collections.d.ts";
 
 const dominant7: ChordCollection = {
@@ -105,7 +105,7 @@ const dominant13: ChordCollection = {
   patternShort: ["M3", "m3", "m3", "M3", "m3", "m3"],
 } as const;
 
-const dominantPentatonic: ScaleCollection = {
+const dominantPentatonic: NonModalScaleCollection = {
   category: "scale",
   primaryName: "Dominant Pentatonic",
   names: ["Dominant Pentatonic"],

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

@@ -1,12 +1,9 @@
-import type {
-  ModalScaleCollection,
-  ParentScaleCollection,
-  ScaleCollection,
-} from "../../types/note-collections.d.ts";
+import type { ModalScaleCollection } from "../../types/note-collections.d.ts";
 
-const harmonicMinor: ParentScaleCollection = {
+const harmonicMinor: ModalScaleCollection = {
   category: "scale",
   rotation: 0,
+  parentScale: "harmonicMinor",
   primaryName: "Harmonic Minor",
   names: [
     "Harmonic Minor",
@@ -258,5 +255,7 @@ export const _harmonicMinorModes = {
 
 export type HarmonicMinorModeKey = keyof typeof _harmonicMinorModes;
 
-export const harmonicMinorModes: Record<HarmonicMinorModeKey, ScaleCollection> =
-  _harmonicMinorModes;
+export const harmonicMinorModes: Record<
+  HarmonicMinorModeKey,
+  ModalScaleCollection
+> = _harmonicMinorModes;

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

@@ -1,12 +1,9 @@
-import type {
-  ModalScaleCollection,
-  ParentScaleCollection,
-  ScaleCollection,
-} from "../../types/note-collections.d.ts";
+import type { ModalScaleCollection } from "../../types/note-collections.d.ts";
 
-const melodicMinor: ParentScaleCollection = {
+const melodicMinor: ModalScaleCollection = {
   category: "scale",
   rotation: 0,
+  parentScale: "melodicMinor",
   primaryName: "Melodic Minor",
   names: [
     "Melodic Minor",
@@ -218,5 +215,7 @@ export const _melodicMinorModes = {
 
 export type MelodicMinorModeKey = keyof typeof _melodicMinorModes;
 
-export const melodicMinorModes: Record<MelodicMinorModeKey, ScaleCollection> =
-  _melodicMinorModes;
+export const melodicMinorModes: Record<
+  MelodicMinorModeKey,
+  ModalScaleCollection
+> = _melodicMinorModes;

package/src/data/note-collections/pentatonic-variants.ts

@@ -1,12 +1,9 @@
-import type {
-  ModalScaleCollection,
-  ParentScaleCollection,
-  ScaleCollection,
-} from "../../types/note-collections.d.ts";
+import type { ModalScaleCollection } from "../../types/note-collections.d.ts";
 
-const majorPentatonic: ParentScaleCollection = {
+const majorPentatonic: ModalScaleCollection = {
   category: "scale",
   rotation: 0,
+  parentScale: "majorPentatonic",
   primaryName: "Major Pentatonic",
   names: ["Major Pentatonic"],
   intervals: ["1", "2", "3", "5", "6", "8"],
@@ -96,5 +93,7 @@ export const _pentatonicVariants = {
 
 export type PentatonicVariantKey = keyof typeof _pentatonicVariants;
 
-export const pentatonicVariants: Record<PentatonicVariantKey, ScaleCollection> =
-  _pentatonicVariants;
+export const pentatonicVariants: Record<
+  PentatonicVariantKey,
+  ModalScaleCollection
+> = _pentatonicVariants;

package/src/types/midi.d.ts

@@ -1,5 +1,3 @@
-export type OctaveNumber = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
-
 export type MidiNoteNumber =
   | 0
   | 1

package/src/types/note-collections.d.ts

@@ -49,28 +49,20 @@ interface NoteCollectionBase {
   readonly patternShort: readonly string[];
 }
 
-/** A scale that is the parent of a set of modes (e.g., Ionian, Melodic Minor). */
-interface ParentScaleCollection extends NoteCollectionBase {
+/** A scale that can be thought of as a mode of a parent scale (e.g., Ionian, Dorian, Lydian Augmented). */
+interface ModalScaleCollection extends NoteCollectionBase {
   /**
    * The fundamental classification of the collection. For scales, this is always "scale".
    */
   readonly category: "scale";
   /**
    * The rotation index for a parent scale is always 0.
-   */
-  readonly rotation: 0;
-  readonly parentScale?: never;
-}
-
-/** A scale that is a mode of a parent scale (e.g., Dorian, Lydian Augmented). */
-interface ModalScaleCollection extends NoteCollectionBase {
-  readonly category: "scale";
-  /**
    * The rotation index relative to a parent scale. e.g., Dorian is 1.
    */
   readonly rotation: number;
   /**
    * The key-name (e.g., "ionian") of the parent scale from which this mode is derived.
+   * The parent scale has itself as parentScale!
    */
   readonly parentScale: string;
 }
@@ -88,7 +80,6 @@ export interface ChordCollection extends NoteCollectionBase {
 }
 
 export type ScaleCollection =
-  | ParentScaleCollection
   | ModalScaleCollection
   | NonModalScaleCollection;
 

package/src/utils/chords.ts

@@ -100,11 +100,6 @@ export function getChordDetailsForDiatonicMode(
   diatonicModeKey: DiatonicModeKey,
 ): ChordDetails[] {
   const mode = diatonicModes[diatonicModeKey];
-  if (mode.rotation === undefined) {
-    throw new Error(
-      `Mode "${diatonicModeKey}" is missing the 'rotation' property.`,
-    );
-  }
   const rotation = mode.rotation;
   const rotatedTriads = rotateArray(diatonicTriads, rotation);
   const rotatedSeventhChords = rotateArray(diatonicSeventhChords, rotation);
@@ -121,11 +116,6 @@ export function getChordDetailsForHarmonicMinorMode(
   harmonicMinorModeKey: HarmonicMinorModeKey,
 ): ChordDetails[] {
   const mode = harmonicMinorModes[harmonicMinorModeKey];
-  if (mode.rotation === undefined) {
-    throw new Error(
-      `Mode "${harmonicMinorModeKey}" is missing the 'rotation' property.`,
-    );
-  }
   const rotation = mode.rotation;
   const rotatedTriads = rotateArray(harmonicMinorTriads, rotation);
   const rotatedSeventhChords = rotateArray(
@@ -145,11 +135,6 @@ export function getChordDetailsForMelodicMinorMode(
   melodicMinorModeKey: MelodicMinorModeKey,
 ): ChordDetails[] {
   const mode = melodicMinorModes[melodicMinorModeKey];
-  if (mode.rotation === undefined) {
-    throw new Error(
-      `Mode "${melodicMinorModeKey}" is missing the 'rotation' property.`,
-    );
-  }
   const rotation = mode.rotation;
   const rotatedTriads = rotateArray(melodicMinorTriads, rotation);
   const rotatedSeventhChords = rotateArray(melodicMinorSeventhChords, rotation);

package/src/utils/midi-note-sequences.ts

@@ -1,6 +1,6 @@
 import type { Interval } from "../data/labels/note-labels.ts";
 import type { MidiNoteNumber, MidiNoteSequence } from "../types/midi.d.ts";
-import { rootMidiAndIntervalToMidi } from "./midi.ts";
+import { noteMidiAndIntervalToMidi } from "./midi.ts";
 
 export type MidiNoteSequenceDirection =
   | "ascending"
@@ -50,7 +50,7 @@ function getMonotonicMidiNoteSequence(
       intervalIndex = (startFromIndex + i) % intervalsLength;
       octaveOffset = Math.floor((startFromIndex + i) / intervalsLength) * 12;
       const interval = intervals[intervalIndex];
-      const note = rootMidiAndIntervalToMidi(rootNoteMidi, interval);
+      const note = noteMidiAndIntervalToMidi(rootNoteMidi, interval);
       if (note === undefined) {
         throw new Error(
           `Could not calculate MIDI note for interval ${interval} at index ${intervalIndex}`,
@@ -75,7 +75,7 @@ function getMonotonicMidiNoteSequence(
         Math.max(0, Math.ceil((i - startFromIndex) / intervalsLength)) * 12;
       const interval = intervals[intervalIndex];
       // Subtract octaveOffset from root before applying interval
-      const note = rootMidiAndIntervalToMidi(
+      const note = noteMidiAndIntervalToMidi(
         (rootNoteMidi - octaveOffset) as MidiNoteNumber,
         interval,
       );

package/src/utils/midi.ts

@@ -3,48 +3,49 @@ import {
   intervalToIntegerMap,
   type NoteName,
   noteNameToIntegerMap,
-  type RootNoteInteger,
 } from "../data/labels/note-labels.ts";
 
-import type { MidiNoteNumber, OctaveNumber } from "../types/midi.d.ts";
+import type { MidiNoteNumber } from "../types/midi.d.ts";
 
-export function rootIntegerAndIntervalToMidi(
-  rootNoteInteger: RootNoteInteger,
+export function noteIntegerAndIntervalToMidi(
+  noteInteger: number,
+  noteOctaveNumber: number,
   interval: Interval,
-  rootNoteOctaveNumber: OctaveNumber = 4,
 ): MidiNoteNumber | undefined {
-  const intervalValue = intervalToIntegerMap.get(interval);
-  if (intervalValue === undefined) return undefined;
-  return (rootNoteOctaveNumber + 1) * 12 + rootNoteInteger +
-    intervalValue as MidiNoteNumber;
+  const intervalInteger = intervalToIntegerMap.get(interval);
+  if (intervalInteger === undefined) return undefined;
+  return (noteOctaveNumber + 1) * 12 + noteInteger +
+    intervalInteger as MidiNoteNumber;
 }
 
-export function rootMidiAndIntervalToMidi(
-  rootNoteMidi: MidiNoteNumber,
+export function noteNameAndIntervalToMidi(
+  noteName: NoteName,
+  noteOctaveNumber: number,
   interval: Interval,
 ): MidiNoteNumber | undefined {
-  const intervalValue = intervalToIntegerMap.get(interval);
-  if (intervalValue === undefined) return undefined;
-  return rootNoteMidi + intervalValue as MidiNoteNumber;
+  const noteInteger = noteNameToIntegerMap.get(noteName);
+  if (noteInteger === undefined) return undefined;
+  return noteIntegerAndIntervalToMidi(
+    noteInteger,
+    noteOctaveNumber,
+    interval,
+  );
 }
 
-export function noteNameToMidi(
-  noteName: NoteName,
-  octaveNumber: OctaveNumber = 4,
+export function noteMidiAndIntervalToMidi(
+  noteMidi: MidiNoteNumber,
+  interval: Interval,
 ): MidiNoteNumber | undefined {
-  const noteValue = noteNameToIntegerMap.get(noteName);
-  if (noteValue === undefined) return undefined;
-  return noteValue + (octaveNumber + 1) * 12 as MidiNoteNumber;
+  const intervalValue = intervalToIntegerMap.get(interval);
+  if (intervalValue === undefined) return undefined;
+  return noteMidi + intervalValue as MidiNoteNumber;
 }
 
-export function noteNameAndIntervalToMidi(
+export function noteNameToMidi(
   noteName: NoteName,
-  interval: Interval,
-  octaveNumber: OctaveNumber = 4,
+  noteOctaveNumber: number,
 ): MidiNoteNumber | undefined {
   const noteValue = noteNameToIntegerMap.get(noteName);
   if (noteValue === undefined) return undefined;
-  const intervalValue = intervalToIntegerMap.get(interval);
-  if (intervalValue === undefined) return undefined;
-  return noteValue + (octaveNumber + 1) * 12 as MidiNoteNumber;
+  return noteValue + (noteOctaveNumber + 1) * 12 as MidiNoteNumber;
 }

package/src/utils/note-names.ts

@@ -122,18 +122,12 @@ export function normalizeRootNoteString(name: string): RootNote | undefined {
   return undefined;
 }
 
-export function noteNameToInteger(
-  noteName: NoteName,
-): RootNoteInteger | undefined {
-  return noteNameToIntegerMap.get(noteName);
-}
-
-export function noteNameStringToInteger(
+export function getNoteIntegerFromString(
   noteName: string,
 ): RootNoteInteger | undefined {
   const normalized = normalizeNoteNameString(noteName);
   if (!normalized) return undefined;
-  return noteNameToInteger(normalized);
+  return noteNameToIntegerMap.get(normalized);
 }
 
 export function getNoteNamesFromRootAndIntervals(
@@ -141,7 +135,7 @@ export function getNoteNamesFromRootAndIntervals(
   intervals: readonly Interval[],
   options: TransformIntervalsOptions = {},
 ): NoteName[] {
-  const rootNoteInteger = noteNameToInteger(rootNote);
+  const rootNoteInteger = noteNameToIntegerMap.get(rootNote);
   if (rootNoteInteger === undefined) return [];
   const rootNoteLetter = rootNote.charAt(0).toUpperCase();
   const rootNoteLetterIndex = noteLetters.indexOf(rootNoteLetter as NoteLetter);