@musodojo/music-theory-data 19.0.3 → 20.1.0

package/README.md

@@ -3,43 +3,101 @@
 **The musician-friendly TypeScript library for modes, scales, chords, and
 more.**
 
-> **Note:** This library is currently under review for accuracy. Please verify
-> data before use in a critical application.
-
 ## Community & Support
 
-Have a question, a suggestion, or want to report a bug? I'd love to hear from
-you!
+Have a question, a suggestion, or want to report a bug? Get in touch!
 
 - **💬 Ask a Question or Share an Idea:** Use
   [GitHub Discussions](https://github.com/conor-dowdall/music-theory-data/discussions).
-- **🐞 Report a Bug or Request a Feature:** Open a
+- **🐞 Report a Bug or Flaw in the Data:** Open a
   [GitHub Issue](https://github.com/conor-dowdall/music-theory-data/issues).
 
-## Verified Note Collections
+## Available Note Collections
 
 - ✅ Diatonic Modes
 - ✅ Pentatonic Variants
 - ✅ Major Variants
 - ✅ Minor Variants
-- 🛠️ Dominant Variants
+- ✅ Dominant Variants
 - ✅ Harmonic Minor Modes
 - ✅ Melodic Minor Modes
-- 🛠️ Diminished Variants
-- 🛠️ Augmented Variants
-- 🛠️ Other Note Collections
+- ✅ Diminished Variants
+- ✅ Augmented Variants
+- ✅ Other Note Collections
 
 ## Features
 
-- **Rich Data Structures:** Access detailed information for scales, modes,
-  chords, and more, including intervals, integer notations, and common names.
-- **Practical Utility Functions:** Helpers for common tasks like generating note
-  names from a root note and a collection key.
 - **Fully Typed:** Written in TypeScript with comprehensive type definitions for
   a great developer experience.
 - **Deno First, NPM Ready:** A modern Deno module that is also published to npm
   for use in Node.js projects.
 
+### Rich Data Structures
+
+Access detailed information for scales, modes, chords, and more, including
+intervals, integer notations, and common names.
+
+```ts
+// src/data/note-collections/diatonic-modes.ts
+const ionian: ModalScaleCollection = {
+  category: "scale",
+  rotation: 0,
+  parentScale: "ionian",
+  primaryName: "Major",
+  names: [
+    "Major",
+    "Ionian",
+    "Major Scale",
+    "Ionian Mode",
+    "Diatonic Major",
+  ],
+  intervals: ["1", "2", "3", "4", "5", "6", "7", "8"],
+  integers: [0, 2, 4, 5, 7, 9, 11],
+  type: [
+    "major",
+    "ionian",
+    "mode",
+    "scale",
+    "church mode",
+    "diatonic mode",
+    "heptatonic",
+    "first diatonic mode",
+    "do mode",
+  ],
+  characteristics: [
+    "bright",
+    "happy",
+    "stable",
+    "uplifting",
+    "consonant",
+    "western",
+    "foundational",
+    "simple",
+    "pop music",
+    "major tonality",
+    "commonly used western scale",
+  ],
+  pattern: ["whole", "whole", "half", "whole", "whole", "whole", "half"],
+  patternShort: ["W", "W", "H", "W", "W", "W", "H"],
+} as const;
+```
+
+### Practical Utility Functions
+
+Helpers for common tasks like generating note names from a root note and a set
+of intervals.
+
+```ts
+// src/utils/note-names.ts
+export function getNoteNamesFromRootAndIntervals(
+  rootNote: RootNote,
+  intervals: readonly Interval[],
+  options: TransformIntervalsOptions = {},
+): NoteName[] {
+  //...
+}
+```
+
 ## Installation
 
 ### Deno / JSR

package/package.json

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

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

@@ -482,7 +482,6 @@ export const intervalQualityToIntegerMap: ReadonlyMap<
   ][],
 );
 
-//TODO: add beyond an octave
 const _intervalToIntervalQualityMap = {
   "𝄫1": "dd1",
   "♭1": "d1",
@@ -491,14 +490,14 @@ const _intervalToIntervalQualityMap = {
   "♯1": "A1",
   "𝄪1": "AA1",
 
-  "𝄫2": "dd2",
+  "𝄫2": "d2",
   "♭2": "m2",
   "2": "M2",
   "♮2": "M2",
   "♯2": "A2",
   "𝄪2": "AA2",
 
-  "𝄫3": "dd3",
+  "𝄫3": "d3",
   "♭3": "m3",
   "3": "M3",
   "♮3": "M3",
@@ -519,19 +518,75 @@ const _intervalToIntervalQualityMap = {
   "♯5": "A5",
   "𝄪5": "AA5",
 
-  "𝄫6": "dd6",
+  "𝄫6": "d6",
   "♭6": "m6",
   "6": "M6",
   "♮6": "M6",
   "♯6": "A6",
   "𝄪6": "AA6",
 
-  "𝄫7": "dd7",
+  "𝄫7": "d7",
   "♭7": "m7",
   "7": "M7",
   "♮7": "M7",
   "♯7": "A7",
   "𝄪7": "AA7",
+
+  "𝄫8": "dd8",
+  "♭8": "d8",
+  "8": "P8",
+  "♮8": "P8",
+  "♯8": "A8",
+  "𝄪8": "AA8",
+
+  "𝄫9": "d9",
+  "♭9": "m9",
+  "9": "M9",
+  "♮9": "M9",
+  "♯9": "A9",
+  "𝄪9": "AA9",
+
+  "𝄫10": "d10",
+  "♭10": "m10",
+  "10": "M10",
+  "♮10": "M10",
+  "♯10": "A10",
+  "𝄪10": "AA10",
+
+  "𝄫11": "dd11",
+  "♭11": "d11",
+  "11": "P11",
+  "♮11": "P11",
+  "♯11": "A11",
+  "𝄪11": "AA11",
+
+  "𝄫12": "dd12",
+  "♭12": "d12",
+  "12": "P12",
+  "♮12": "P12",
+  "♯12": "A12",
+  "𝄪12": "AA12",
+
+  "𝄫13": "d13",
+  "♭13": "m13",
+  "13": "M13",
+  "♮13": "M13",
+  "♯13": "A13",
+  "𝄪13": "AA13",
+
+  "𝄫14": "d14",
+  "♭14": "m14",
+  "14": "M14",
+  "♮14": "M14",
+  "♯14": "A14",
+  "𝄪14": "AA14",
+
+  "𝄫15": "dd15",
+  "♭15": "d15",
+  "15": "P15",
+  "♮15": "P15",
+  "♯15": "A15",
+  "𝄪15": "AA15",
 } as const;
 
 export const intervalToIntervalQualityMap: ReadonlyMap<
@@ -544,7 +599,6 @@ export const intervalToIntervalQualityMap: ReadonlyMap<
   ][],
 );
 
-//TODO: add beyond an octave
 const _intervalQualityToIntervalMap = {
   "dd1": "𝄫1",
   "d1": "♭1",
@@ -552,15 +606,13 @@ const _intervalQualityToIntervalMap = {
   "A1": "♯1",
   "AA1": "𝄪1",
 
-  "dd2": "𝄫2",
-  "d2": "♭2",
+  "d2": "𝄫2",
   "m2": "♭2",
   "M2": "2",
   "A2": "♯2",
   "AA2": "𝄪2",
 
-  "dd3": "𝄫3",
-  "d3": "♭3",
+  "d3": "𝄫3",
   "m3": "♭3",
   "M3": "3",
   "A3": "♯3",
@@ -578,19 +630,65 @@ const _intervalQualityToIntervalMap = {
   "A5": "♯5",
   "AA5": "𝄪5",
 
-  "dd6": "𝄫6",
-  "d6": "♭6",
+  "d6": "𝄫6",
   "m6": "♭6",
   "M6": "6",
   "A6": "♯6",
   "AA6": "𝄪6",
 
-  "dd7": "𝄫7",
-  "d7": "♭7",
+  "d7": "𝄫7",
   "m7": "♭7",
   "M7": "7",
   "A7": "♯7",
   "AA7": "𝄪7",
+
+  "dd8": "𝄫8",
+  "d8": "♭8",
+  "P8": "8",
+  "A8": "♯8",
+  "AA8": "𝄪8",
+
+  "d9": "𝄫9",
+  "m9": "♭9",
+  "M9": "9",
+  "A9": "♯9",
+  "AA9": "𝄪9",
+
+  "d10": "𝄫10",
+  "m10": "♭10",
+  "M10": "10",
+  "A10": "♯10",
+  "AA10": "𝄪10",
+
+  "dd11": "𝄫11",
+  "d11": "♭11",
+  "P11": "11",
+  "A11": "♯11",
+  "AA11": "𝄪11",
+
+  "dd12": "𝄫12",
+  "d12": "♭12",
+  "P12": "12",
+  "A12": "♯12",
+  "AA12": "𝄪12",
+
+  "d13": "𝄫13",
+  "m13": "♭13",
+  "M13": "13",
+  "A13": "♯13",
+  "AA13": "𝄪13",
+
+  "d14": "𝄫14",
+  "m14": "♭14",
+  "M14": "14",
+  "A14": "♯14",
+  "AA14": "𝄪14",
+
+  "dd15": "𝄫15",
+  "d15": "♭15",
+  "P15": "15",
+  "A15": "♯15",
+  "AA15": "𝄪15",
 } as const;
 
 export const intervalQualityToIntervalMap: ReadonlyMap<

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

@@ -6,7 +6,7 @@ const augmentedTriad: ChordCollection = {
   names: ["aug", "+", "Augmented Triad"],
   intervals: ["1", "3", "♯5"],
   integers: [0, 4, 8],
-  type: ["augmented", "chord", "arpeggio", "triad", "symmetrical"],
+  type: ["augmented", "chord", "arpeggio", "triad"],
   characteristics: ["tense", "unstable", "dreamy", "dissonant"],
   pattern: ["major third", "major third"],
   patternShort: ["M3", "M3"],
@@ -20,66 +20,13 @@ const augmented7: ChordCollection = {
   integers: [0, 4, 8, 10],
   type: ["augmented", "dominant", "chord", "arpeggio", "tetrad"],
   characteristics: ["tense", "unstable", "dissonant", "dominant function"],
-  pattern: ["major third", "major third", "minor second"],
-  patternShort: ["M3", "M3", "m2"],
-} as const;
-
-const italian6: ChordCollection = {
-  category: "chord",
-  primaryName: "It+6",
-  names: ["It+6", "Italian 6th"],
-  intervals: ["1", "3", "♭6"],
-  integers: [0, 4, 8],
-  type: ["augmented", "chord", "arpeggio", "triad", "classical"],
-  characteristics: [
-    "classical harmony",
-    "pre-dominant function",
-    "chromatic",
-  ],
-  pattern: ["major third", "diminished fourth"],
-  patternShort: ["M3", "d4"],
-} as const;
-
-const french6: ChordCollection = {
-  category: "chord",
-  primaryName: "Fr+6",
-  names: ["Fr+6", "French 6th"],
-  intervals: ["1", "3", "♯4", "♭6"],
-  integers: [0, 4, 6, 8],
-  type: ["augmented", "chord", "arpeggio", "tetrad", "classical"],
-  characteristics: [
-    "classical harmony",
-    "pre-dominant function",
-    "chromatic",
-    "contains a tritone",
-  ],
-  pattern: ["major third", "minor second", "major second"],
-  patternShort: ["M3", "m2", "M2"],
-} as const;
-
-const german6: ChordCollection = {
-  category: "chord",
-  primaryName: "Ger+6",
-  names: ["Ger+6", "German 6th"],
-  intervals: ["1", "3", "5", "♭6"],
-  integers: [0, 4, 7, 8],
-  type: ["augmented", "chord", "arpeggio", "tetrad", "classical"],
-  characteristics: [
-    "classical harmony",
-    "pre-dominant function",
-    "chromatic",
-    "enharmonically equivalent to a dominant 7th",
-  ],
-  pattern: ["major third", "minor third", "augmented unison"],
-  patternShort: ["M3", "m3", "A1"],
+  pattern: ["major third", "major third", "major second"],
+  patternShort: ["M3", "M3", "M2"],
 } as const;
 
 export const _augmentedVariants = {
   augmentedTriad,
   augmented7,
-  italian6,
-  french6,
-  german6,
 } as const;
 
 export type AugmentedVariantKey = keyof typeof _augmentedVariants;

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

@@ -60,7 +60,7 @@ const halfWholeDiminished: ModalScaleCollection = {
   parentScale: "wholeHalfDiminished",
   primaryName: "Half Whole Diminished",
   names: ["Half Whole Diminished", "Dominant Diminished"],
-  intervals: ["1", "♭2", "♭3", "3", "♯4", "5", "6", "♭7", "8"],
+  intervals: ["1", "♭2", "♯2", "3", "♯4", "5", "6", "♭7", "8"],
   integers: [0, 1, 3, 4, 6, 7, 9, 10],
   type: ["diminished", "dominant", "scale", "symmetrical", "octatonic"],
   characteristics: [

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

@@ -33,7 +33,7 @@ const dominant9: ChordCollection = {
   primaryName: "9",
   names: ["9", "dom9", "Dominant 9th", "Dominant Ninth"],
   intervals: ["1", "3", "5", "♭7", "9"],
-  integers: [0, 2, 4, 7, 10],
+  integers: [0, 4, 7, 10, 14],
   type: ["dominant", "major", "chord", "arpeggio", "pentad"],
   characteristics: [
     "unstable",
@@ -53,7 +53,7 @@ const dominant11: ChordCollection = {
   primaryName: "11",
   names: ["11", "dom11", "Dominant 11th", "Dominant Eleventh"],
   intervals: ["1", "3", "5", "♭7", "9", "11"],
-  integers: [0, 2, 4, 5, 7, 10],
+  integers: [0, 4, 7, 10, 14, 17],
   type: ["dominant", "major", "chord", "arpeggio", "hexad"],
   characteristics: [
     "unstable",
@@ -81,7 +81,7 @@ const dominant13: ChordCollection = {
   primaryName: "13",
   names: ["13", "dom13", "Dominant 13th", "Dominant Thirteenth"],
   intervals: ["1", "3", "5", "♭7", "9", "11", "13"],
-  integers: [0, 2, 4, 5, 7, 9, 10],
+  integers: [0, 4, 7, 10, 14, 17, 21],
   type: ["dominant", "major", "chord", "arpeggio", "heptad"],
   characteristics: [
     "unstable",
@@ -100,9 +100,9 @@ const dominant13: ChordCollection = {
     "minor third",
     "major third",
     "minor third",
-    "minor third",
+    "major third",
   ],
-  patternShort: ["M3", "m3", "m3", "M3", "m3", "m3"],
+  patternShort: ["M3", "m3", "m3", "M3", "m3", "M3"],
 } as const;
 
 const dominantPentatonic: NonModalScaleCollection = {

package/src/data/note-collections/other-collections.ts

@@ -1,9 +1,34 @@
 import type {
+  ChordCollection,
+  NonModalScaleCollection,
   NoteCollection,
-  ScaleCollection,
 } from "../../types/note-collections.d.ts";
 
-const chromatic: ScaleCollection = {
+const rootAndFifth: ChordCollection = {
+  category: "chord",
+  primaryName: "Root and Fifth",
+  names: ["Root and Fifth", "Power Chord"],
+  intervals: ["1", "5"],
+  integers: [0, 7],
+  type: ["chord", "power chord"],
+  characteristics: ["rock", "blues", "metal"],
+  pattern: ["perfect fifth"],
+  patternShort: ["P5"],
+};
+
+const bluesPentatonic: NonModalScaleCollection = {
+  category: "scale",
+  primaryName: "Blues Pentatonic",
+  names: ["Blues Pentatonic"],
+  intervals: ["1", "♭3", "4", "♭5", "5", "♭7", "8"],
+  integers: [0, 3, 5, 6, 7, 10],
+  type: ["blues", "pentatonic", "scale", "gapped scale"],
+  characteristics: ["bluesy", "rock"],
+  pattern: ["minor third", "whole", "half", "half", "minor third", "whole"],
+  patternShort: ["m3", "W", "H", "H", "m3", "W"],
+};
+
+const chromatic: NonModalScaleCollection = {
   category: "scale",
   primaryName: "Chromatic",
   names: ["Chromatic", "Twelve-Tone Scale"],
@@ -47,7 +72,7 @@ const chromatic: ScaleCollection = {
   patternShort: ["H", "H", "H", "H", "H", "H", "H", "H", "H", "H", "H"],
 } as const;
 
-const wholeTone: ScaleCollection = {
+const wholeTone: NonModalScaleCollection = {
   category: "scale",
   primaryName: "Whole Tone Scale",
   names: ["Whole Tone Scale"],
@@ -63,11 +88,13 @@ const wholeTone: ScaleCollection = {
     "often used in film scores",
     "associated with composers like Debussy and Ravel",
   ],
-  pattern: ["whole", "whole", "whole", "whole", "whole"],
-  patternShort: ["W", "W", "W", "W", "W"],
+  pattern: ["whole", "whole", "whole", "whole", "whole", "whole"],
+  patternShort: ["W", "W", "W", "W", "W", "W"],
 } as const;
 
 export const _otherNoteCollections = {
+  rootAndFifth,
+  bluesPentatonic,
   chromatic,
   wholeTone,
 } as const;

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

@@ -8,13 +8,13 @@ export type MidiNoteSequenceDirection =
   | "ascending-descending"
   | "descending-ascending";
 
-// TODO: add property `restsAtEnd` to add null values to array end
 export interface MidiNoteSequenceOptions {
   rootNoteMidi: MidiNoteNumber;
   intervals: Interval[];
   direction: MidiNoteSequenceDirection;
   startFromIndex?: number;
   filterOutOctave?: boolean;
+  restsAtEnd?: number;
   numNotes?: number;
   numOctaves?: number;
   extraNotes?: number;
@@ -109,6 +109,7 @@ export function getMidiNoteSequence(
     filterOutOctave = true,
     numNotes,
     numOctaves = 1,
+    restsAtEnd = 0,
     extraNotes = 0,
   } = options;
 
@@ -164,5 +165,7 @@ export function getMidiNoteSequence(
     }
   }
 
+  if (restsAtEnd > 0) sequence.push(...Array(restsAtEnd).fill(null));
+
   return sequence;
 }

package/src/data/note-collections/todo.txt

@@ -1,76 +0,0 @@
-  // Diminished
-  {
-    name: "dim / o / Diminished Triad",
-    sequence: [0, 3, 6],
-  },
-  {
-    name: "dim7 / o7 / Diminished 7th",
-    sequence: [0, 3, 6, 9],
-  },
-  {
-    name: "m7♭5 / ø7 / Half Diminished 7th",
-    sequence: [0, 3, 6, 10],
-  },
-  {
-    name: "Whole Half Diminished",
-    sequence: [0, 2, 3, 5, 6, 8, 9, 11],
-  },
-  {
-    name: "Half Whole / Dominant Diminished",
-    sequence: [0, 1, 3, 4, 6, 7, 9, 10],
-  },
-
-  // Augmented
-  {
-    name: "aug / + / Augmented Triad",
-    sequence: [0, 4, 8],
-  },
-  {
-    name: "It+6 / Italian 6th",
-    sequence: [0, 4, 10],
-  },
-  {
-    name: "Fr+6 / French 6th",
-    sequence: [0, 4, 6, 10],
-  },
-  {
-    name: "Ger+6 / German 6th",
-    sequence: [0, 4, 7, 10],
-  },
-  {
-    name: "aug7 / +7 / 7♯5 / Augmented Seventh",
-    sequence: [0, 4, 8, 10],
-  },
-
-  // Other
-  {
-    name: "R / Root",
-    category: "Other",
-    sequence: [0],
-  },
-  {
-    name: "Chromatic",
-    category: "Other",
-    sequence: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11],
-  },
-  {
-    name: "Blank",
-    category: "Other",
-    sequence: [],
-  },
-  {
-    name: "Root and 5th",
-    category: "Other",
-    sequence: [0, 7],
-  },
-  {
-    name: "Blues",
-    category: "Other",
-    sequence: [0, 3, 5, 6, 7, 10],
-  },
-  {
-    name: "Whole Tone",
-    category: "Other",
-    sequence: [0, 2, 4, 6, 8, 10],
-  },
-];