@musodojo/music-theory-data 16.0.7 → 16.1.1

package/README.md

@@ -6,6 +6,19 @@ more.**
 > **Note:** This library is currently under review for accuracy. Please verify
 > data before use in a critical application.
 
+## Verified Note Collections
+
+- ✅ Diatonic Modes
+- 🛠️ Pentatonic Variants
+- 🛠️ Major Variants
+- 🛠️ Minor Variants
+- 🛠️ Dominant Variants
+- ✅ Harmonic Minor Modes
+- 🛠️ Melodic Minor Modes
+- 🛠️ Diminished Variants
+- 🛠️ Augmented Variants
+- 🛠️ Other Note Collections
+
 ## Features
 
 - **Rich Data Structures:** Access detailed information for scales, modes,
@@ -47,9 +60,11 @@ Then import it into your project:
 import * as music_theory_data from "@musodojo/music-theory-data";
 ```
 
-## Usage Example
+## Usage Examples
+
+Note: the `tests/` directory contains many useful examples.
 
-Get the notes of a scale or the details of a mode.
+The code below shows how to access and print some of the data.
 
 ```ts
 import * as music_theory_data from "jsr:@musodojo/music-theory-data";
@@ -62,6 +77,11 @@ const notes = music_theory_data.getNoteNamesFromRootAndCollectionKey(
 console.log(notes);
 // ["A", "B", "C", "D", "E", "F", "G♯", "A"]
 
+// Automatically knows whether to use flats or sharps
+notes = music_theory_data.getNoteNamesFromRootAndCollectionKey("F", "ionian");
+console.log(notes);
+//  ["F", "G", "A", "B♭", "C", "D", "E", "F"];
+
 // Get the full data structure for the Ionian mode (Major Scale)
 const ionian = music_theory_data.noteCollections.ionian;
 

package/package.json

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

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

@@ -95,9 +95,9 @@ const ionianSharp5: ScaleCollection = {
     "augmented second",
     "half",
     "whole",
-    "whole",
+    "half",
   ],
-  patternShort: ["W", "W", "H", "A2", "H", "W", "W"],
+  patternShort: ["W", "W", "H", "A2", "H", "W", "H"],
 } as const;
 
 const dorianSharp4: ScaleCollection = {
@@ -122,10 +122,10 @@ const dorianSharp4: ScaleCollection = {
     "augmented second",
     "half",
     "whole",
-    "whole",
     "half",
+    "whole",
   ],
-  patternShort: ["W", "H", "A2", "H", "W", "W", "H"],
+  patternShort: ["W", "H", "A2", "H", "W", "H", "W"],
 } as const;
 
 const phrygianDominant: ScaleCollection = {
@@ -187,9 +187,9 @@ const lydianSharp2: ScaleCollection = {
     "half",
     "whole",
     "whole",
-    "whole",
+    "half",
   ],
-  patternShort: ["A2", "H", "W", "H", "W", "W", "W"],
+  patternShort: ["A2", "H", "W", "H", "W", "W", "H"],
 } as const;
 
 const superLocrianDoubleFlat7: ScaleCollection = {
@@ -211,8 +211,16 @@ const superLocrianDoubleFlat7: ScaleCollection = {
     "altered",
     "theoretical",
   ],
-  pattern: ["half", "whole", "half", "whole", "whole", "half", "whole"],
-  patternShort: ["H", "W", "H", "W", "W", "H", "W"],
+  pattern: [
+    "half",
+    "whole",
+    "half",
+    "whole",
+    "whole",
+    "half",
+    "augmented second",
+  ],
+  patternShort: ["H", "W", "H", "W", "W", "H", "A2"],
 } as const;
 
 export const _harmonicMinorModes = {

package/src/utils/intervals.ts

@@ -9,6 +9,7 @@ import {
   simpleToCompoundIntervalMap,
   simpleToExtensionIntervalMap,
 } from "../data/labels/note-labels.ts";
+import type { NoteCollection } from "../types/note-collections.d.ts";
 
 export function filterOutOctaveIntervals(
   intervals: readonly Interval[],
@@ -97,3 +98,14 @@ export function getIntervalsFromQualities(
     return interval ? [interval] : [];
   });
 }
+
+/**
+ * Extracts the interval qualities (e.g., "P1", "M2", "m3") from a NoteCollection.
+ * @param collection The NoteCollection object.
+ * @returns An array of IntervalQuality strings.
+ */
+export function getQualitiesFromNoteCollection(
+  collection: NoteCollection,
+): IntervalQuality[] {
+  return getQualitiesFromIntervals(collection.intervals);
+}