@musodojo/music-theory-data 15.4.0 → 16.0.7

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

@@ -1,6 +1,11 @@
-import type { NoteCollection } from "../../types/note-collections.d.ts";
+import type {
+  ChordCollection,
+  NoteCollection,
+  ScaleCollection,
+} from "../../types/note-collections.d.ts";
 
-const dominant7: NoteCollection = {
+const dominant7: ChordCollection = {
+  category: "chord",
   primaryName: "7",
   names: ["7", "dom7", "Dominant 7th", "Dominant Seventh"],
   intervals: ["1", "3", "5", "♭7"],
@@ -23,7 +28,8 @@ const dominant7: NoteCollection = {
   patternShort: ["M3", "m3", "m3"],
 } as const;
 
-const dominant9: NoteCollection = {
+const dominant9: ChordCollection = {
+  category: "chord",
   primaryName: "9",
   names: ["9", "dom9", "Dominant 9th", "Dominant Ninth"],
   intervals: ["1", "3", "5", "♭7", "9"],
@@ -42,7 +48,8 @@ const dominant9: NoteCollection = {
   patternShort: ["M3", "m3", "m3", "M3"],
 } as const;
 
-const dominant11: NoteCollection = {
+const dominant11: ChordCollection = {
+  category: "chord",
   primaryName: "11",
   names: ["11", "dom11", "Dominant 11th", "Dominant Eleventh"],
   intervals: ["1", "3", "5", "♭7", "9", "11"],
@@ -69,7 +76,8 @@ const dominant11: NoteCollection = {
   patternShort: ["M3", "m3", "m3", "M3", "m3"],
 } as const;
 
-const dominant13: NoteCollection = {
+const dominant13: ChordCollection = {
+  category: "chord",
   primaryName: "13",
   names: ["13", "dom13", "Dominant 13th", "Dominant Thirteenth"],
   intervals: ["1", "3", "5", "♭7", "9", "11", "13"],
@@ -97,11 +105,24 @@ const dominant13: NoteCollection = {
   patternShort: ["M3", "m3", "m3", "M3", "m3", "m3"],
 } as const;
 
+const dominantPentatonic: ScaleCollection = {
+  category: "scale",
+  primaryName: "Dominant Pentatonic",
+  names: ["Dominant Pentatonic"],
+  intervals: ["1", "2", "3", "5", "♭7", "8"],
+  integers: [0, 2, 4, 7, 10],
+  type: ["dominant", "pentatonic", "scale", "gapped scale"],
+  characteristics: ["bluesy", "dominant feel", "mixolydian flavor"],
+  pattern: ["whole", "whole", "minor third", "minor third"],
+  patternShort: ["W", "W", "m3", "m3"],
+} as const;
+
 export const _dominantVariants = {
   dominant7,
   dominant9,
   dominant11,
   dominant13,
+  dominantPentatonic,
 } as const;
 
 export type DominantVariantKey = keyof typeof _dominantVariants;

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

@@ -1,6 +1,8 @@
-import type { NoteCollection } from "../../types/note-collections.d.ts";
+import type { ScaleCollection } from "../../types/note-collections.d.ts";
 
-const harmonicMinor: NoteCollection = {
+const harmonicMinor: ScaleCollection = {
+  category: "scale",
+  rotation: 0,
   primaryName: "Harmonic Minor",
   names: [
     "Harmonic Minor",
@@ -10,7 +12,6 @@ const harmonicMinor: NoteCollection = {
   ],
   intervals: ["1", "2", "♭3", "4", "5", "♭6", "7", "8"],
   integers: [0, 2, 3, 5, 7, 8, 11],
-  rotation: 0,
   type: ["harmonic minor mode", "minor", "scale", "mode", "heptatonic"],
   characteristics: [
     "dark",
@@ -33,12 +34,13 @@ const harmonicMinor: NoteCollection = {
   patternShort: ["W", "H", "W", "W", "H", "A2", "H"],
 } as const;
 
-const locrianNatural6: NoteCollection = {
+const locrianNatural6: ScaleCollection = {
+  category: "scale",
+  rotation: 1,
   primaryName: "Locrian ♮6",
   names: ["Locrian ♮6", "Locrian Natural Sixth", "Locrian Raised Sixth"],
   intervals: ["1", "♭2", "♭3", "4", "♭5", "6", "♭7", "8"],
   integers: [0, 1, 3, 5, 6, 9, 10],
-  rotation: 1,
   type: ["harmonic minor mode", "diminished", "scale", "mode", "heptatonic"],
   characteristics: [
     "dark",
@@ -59,7 +61,9 @@ const locrianNatural6: NoteCollection = {
   patternShort: ["H", "W", "W", "H", "A2", "H", "W"],
 } as const;
 
-const ionianSharp5: NoteCollection = {
+const ionianSharp5: ScaleCollection = {
+  category: "scale",
+  rotation: 2,
   primaryName: "Ionian ♯5",
   names: [
     "Ionian ♯5",
@@ -69,7 +73,6 @@ const ionianSharp5: NoteCollection = {
   ],
   intervals: ["1", "2", "3", "4", "♯5", "6", "7", "8"],
   integers: [0, 2, 4, 5, 8, 9, 11],
-  rotation: 2,
   type: [
     "harmonic minor mode",
     "major",
@@ -97,7 +100,9 @@ const ionianSharp5: NoteCollection = {
   patternShort: ["W", "W", "H", "A2", "H", "W", "W"],
 } as const;
 
-const dorianSharp4: NoteCollection = {
+const dorianSharp4: ScaleCollection = {
+  category: "scale",
+  rotation: 3,
   primaryName: "Dorian ♯4",
   names: [
     "Dorian ♯4",
@@ -109,7 +114,6 @@ const dorianSharp4: NoteCollection = {
   ],
   intervals: ["1", "2", "♭3", "♯4", "5", "6", "♭7", "8"],
   integers: [0, 2, 3, 6, 7, 9, 10],
-  rotation: 3,
   type: ["harmonic minor mode", "minor", "scale", "heptatonic"],
   characteristics: ["exotic minor", "eastern european folk", "gypsy"],
   pattern: [
@@ -124,7 +128,9 @@ const dorianSharp4: NoteCollection = {
   patternShort: ["W", "H", "A2", "H", "W", "W", "H"],
 } as const;
 
-const phrygianDominant: NoteCollection = {
+const phrygianDominant: ScaleCollection = {
+  category: "scale",
+  rotation: 4,
   primaryName: "Phrygian Dominant",
   names: [
     "Phrygian Dominant",
@@ -138,7 +144,6 @@ const phrygianDominant: NoteCollection = {
   ],
   intervals: ["1", "♭2", "3", "4", "5", "♭6", "♭7", "8"],
   integers: [0, 1, 4, 5, 7, 8, 10],
-  rotation: 4,
   type: ["harmonic minor mode", "dominant", "scale", "heptatonic"],
   characteristics: [
     "very exotic",
@@ -161,7 +166,9 @@ const phrygianDominant: NoteCollection = {
   patternShort: ["H", "A2", "H", "W", "H", "W", "W"],
 } as const;
 
-const lydianSharp2: NoteCollection = {
+const lydianSharp2: ScaleCollection = {
+  category: "scale",
+  rotation: 5,
   primaryName: "Lydian ♯2",
   names: [
     "Lydian ♯2",
@@ -171,7 +178,6 @@ const lydianSharp2: NoteCollection = {
   ],
   intervals: ["1", "♯2", "3", "♯4", "5", "6", "7", "8"],
   integers: [0, 3, 4, 6, 7, 9, 11],
-  rotation: 5,
   type: ["harmonic minor mode", "major", "scale", "heptatonic"],
   characteristics: ["very bright", "unusual", "double augmented", "exotic"],
   pattern: [
@@ -186,7 +192,9 @@ const lydianSharp2: NoteCollection = {
   patternShort: ["A2", "H", "W", "H", "W", "W", "W"],
 } as const;
 
-const superLocrianDoubleFlat7: NoteCollection = {
+const superLocrianDoubleFlat7: ScaleCollection = {
+  category: "scale",
+  rotation: 6,
   primaryName: "Super Locrian 𝄫7",
   names: [
     "Super Locrian 𝄫7",
@@ -196,7 +204,6 @@ const superLocrianDoubleFlat7: NoteCollection = {
   ],
   intervals: ["1", "♭2", "♭3", "♭4", "♭5", "♭6", "𝄫7", "8"],
   integers: [0, 1, 3, 4, 6, 8, 9],
-  rotation: 6,
   type: ["harmonic minor mode", "diminished", "scale", "heptatonic"],
   characteristics: [
     "extremely tense",
@@ -220,5 +227,5 @@ export const _harmonicMinorModes = {
 
 export type HarmonicMinorModeKey = keyof typeof _harmonicMinorModes;
 
-export const harmonicMinorModes: Record<HarmonicMinorModeKey, NoteCollection> =
+export const harmonicMinorModes: Record<HarmonicMinorModeKey, ScaleCollection> =
   _harmonicMinorModes;

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

@@ -1,6 +1,7 @@
-import type { NoteCollection } from "../../types/note-collections.d.ts";
+import type { ChordCollection } from "../../types/note-collections.d.ts";
 
-const major: NoteCollection = {
+const major: ChordCollection = {
+  category: "chord",
   primaryName: "M",
   names: ["M", "maj", "Major", "Major Triad", "Δ"],
   intervals: ["1", "3", "5"],
@@ -16,7 +17,8 @@ const major: NoteCollection = {
   patternShort: ["M3", "m3"],
 } as const;
 
-const major6: NoteCollection = {
+const major6: ChordCollection = {
+  category: "chord",
   primaryName: "6",
   names: ["6", "M6", "maj6", "Major 6th", "Major Sixth"],
   intervals: ["1", "3", "5", "6"],
@@ -35,7 +37,8 @@ const major6: NoteCollection = {
   patternShort: ["M3", "m3", "M2"],
 } as const;
 
-const major7: NoteCollection = {
+const major7: ChordCollection = {
+  category: "chord",
   primaryName: "M7",
   names: ["M7", "maj7", "Major 7th", "Major Seventh", "Δ7"],
   intervals: ["1", "3", "5", "7"],
@@ -53,7 +56,8 @@ const major7: NoteCollection = {
   patternShort: ["M3", "m3", "M3"],
 } as const;
 
-const major9: NoteCollection = {
+const major9: ChordCollection = {
+  category: "chord",
   primaryName: "M9",
   names: ["M9", "maj9", "Major 9th", "Major Ninth", "Δ9"],
   intervals: ["1", "3", "5", "7", "9"],
@@ -72,7 +76,8 @@ const major9: NoteCollection = {
   patternShort: ["M3", "m3", "M3", "m3"],
 } as const;
 
-const majorAdd9: NoteCollection = {
+const majorAdd9: ChordCollection = {
+  category: "chord",
   primaryName: "add9",
   names: ["add9", "maj(add9)", "M(add9)", "Major add 9"],
   intervals: ["1", "3", "5", "9"],
@@ -91,7 +96,8 @@ const majorAdd9: NoteCollection = {
   patternShort: ["M3", "m3", "P5"],
 } as const;
 
-const major6Add9: NoteCollection = {
+const major6Add9: ChordCollection = {
+  category: "chord",
   primaryName: "6/9",
   names: ["6/9", "M6/9", "maj6/9", "Major 6/9", "6add9", "Major add 6 add 9"],
   intervals: ["1", "3", "5", "6", "9"],
@@ -125,5 +131,5 @@ export const _majorVariants = {
 
 export type MajorVariantKey = keyof typeof _majorVariants;
 
-export const majorVariants: Record<MajorVariantKey, NoteCollection> =
+export const majorVariants: Record<MajorVariantKey, ChordCollection> =
   _majorVariants;

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

@@ -1,6 +1,8 @@
-import type { NoteCollection } from "../../types/note-collections.d.ts";
+import type { ScaleCollection } from "../../types/note-collections.d.ts";
 
-const melodicMinor: NoteCollection = {
+const melodicMinor: ScaleCollection = {
+  category: "scale",
+  rotation: 0,
   primaryName: "Melodic Minor",
   names: [
     "Melodic Minor",
@@ -31,7 +33,9 @@ const melodicMinor: NoteCollection = {
   patternShort: ["W", "H", "W", "W", "W", "W", "H"],
 } as const;
 
-const dorianFlat2: NoteCollection = {
+const dorianFlat2: ScaleCollection = {
+  category: "scale",
+  rotation: 1,
   primaryName: "Dorian ♭2",
   names: [
     "Dorian ♭2",
@@ -55,7 +59,9 @@ const dorianFlat2: NoteCollection = {
   patternShort: ["H", "W", "W", "W", "W", "H", "W"],
 } as const;
 
-const lydianAugmented: NoteCollection = {
+const lydianAugmented: ScaleCollection = {
+  category: "scale",
+  rotation: 2,
   primaryName: "Lydian Augmented",
   names: ["Lydian Augmented", "Lydian ♯5", "Lydian Sharp Fifth"],
   intervals: ["1", "2", "3", "♯4", "♯5", "6", "7", "8"],
@@ -80,7 +86,9 @@ const lydianAugmented: NoteCollection = {
   patternShort: ["W", "W", "W", "W", "H", "W", "H"],
 } as const;
 
-const lydianDominant: NoteCollection = {
+const lydianDominant: ScaleCollection = {
+  category: "scale",
+  rotation: 3,
   primaryName: "Lydian Dominant",
   names: [
     "Lydian Dominant",
@@ -108,7 +116,9 @@ const lydianDominant: NoteCollection = {
   patternShort: ["W", "W", "W", "H", "W", "H", "W"],
 } as const;
 
-const mixolydianFlat6: NoteCollection = {
+const mixolydianFlat6: ScaleCollection = {
+  category: "scale",
+  rotation: 4,
   primaryName: "Mixolydian ♭6",
   names: [
     "Mixolydian ♭6",
@@ -133,7 +143,9 @@ const mixolydianFlat6: NoteCollection = {
   patternShort: ["W", "W", "H", "W", "H", "W", "W"],
 } as const;
 
-const aeolianFlat5: NoteCollection = {
+const aeolianFlat5: ScaleCollection = {
+  category: "scale",
+  rotation: 5,
   primaryName: "Aeolian ♭5",
   names: [
     "Aeolian ♭5",
@@ -158,7 +170,9 @@ const aeolianFlat5: NoteCollection = {
   patternShort: ["W", "H", "W", "H", "W", "W", "W"],
 } as const;
 
-const altered: NoteCollection = {
+const altered: ScaleCollection = {
+  category: "scale",
+  rotation: 6,
   primaryName: "Altered Scale",
   names: [
     "Altered Scale",
@@ -194,5 +208,5 @@ export const _melodicMinorModes = {
 
 export type MelodicMinorModeKey = keyof typeof _melodicMinorModes;
 
-export const melodicMinorModes: Record<MelodicMinorModeKey, NoteCollection> =
+export const melodicMinorModes: Record<MelodicMinorModeKey, ScaleCollection> =
   _melodicMinorModes;

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

@@ -1,6 +1,7 @@
-import type { NoteCollection } from "../../types/note-collections.d.ts";
+import type { ChordCollection } from "../../types/note-collections.d.ts";
 
-const minor: NoteCollection = {
+const minor: ChordCollection = {
+  category: "chord",
   primaryName: "m",
   names: ["m", "min", "Minor", "Minor Triad", "-"],
   intervals: ["1", "♭3", "5"],
@@ -16,7 +17,8 @@ const minor: NoteCollection = {
   patternShort: ["m3", "M3"],
 } as const;
 
-const minor6: NoteCollection = {
+const minor6: ChordCollection = {
+  category: "chord",
   primaryName: "m6",
   names: ["m6", "min6", "Minor 6th", "Minor Sixth"],
   intervals: ["1", "♭3", "5", "6"],
@@ -32,7 +34,8 @@ const minor6: NoteCollection = {
   patternShort: ["m3", "M3", "M2"],
 } as const;
 
-const minor7: NoteCollection = {
+const minor7: ChordCollection = {
+  category: "chord",
   primaryName: "m7",
   names: ["m7", "min7", "Minor 7th", "Minor Seventh", "-7"],
   intervals: ["1", "♭3", "5", "♭7"],
@@ -43,7 +46,8 @@ const minor7: NoteCollection = {
   patternShort: ["m3", "M3", "m3"],
 } as const;
 
-const minor9: NoteCollection = {
+const minor9: ChordCollection = {
+  category: "chord",
   primaryName: "m9",
   names: ["m9", "min9", "Minor 9th", "Minor Ninth", "-9"],
   intervals: ["1", "♭3", "5", "♭7", "9"],
@@ -54,7 +58,8 @@ const minor9: NoteCollection = {
   patternShort: ["m3", "M3", "m3", "M3"],
 } as const;
 
-const minorAdd9: NoteCollection = {
+const minorAdd9: ChordCollection = {
+  category: "chord",
   primaryName: "m(add9)",
   names: ["m(add9)", "min(add9)", "Minor add 9"],
   intervals: ["1", "♭3", "5", "9"],
@@ -70,7 +75,8 @@ const minorAdd9: NoteCollection = {
   patternShort: ["m3", "M3", "P5"],
 } as const;
 
-const minor6Add9: NoteCollection = {
+const minor6Add9: ChordCollection = {
+  category: "chord",
   primaryName: "m6/9",
   names: ["m6/9", "min6/9", "Minor 6/9"],
   intervals: ["1", "♭3", "5", "6", "9"],
@@ -97,5 +103,5 @@ export const _minorVariants = {
 
 export type MinorVariantKey = keyof typeof _minorVariants;
 
-export const minorVariants: Record<MinorVariantKey, NoteCollection> =
+export const minorVariants: Record<MinorVariantKey, ChordCollection> =
   _minorVariants;

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

@@ -5,8 +5,8 @@ import { minorVariants } from "./minor-variants.ts";
 import { dominantVariants } from "./dominant-variants.ts";
 import { harmonicMinorModes } from "./harmonic-minor-modes.ts";
 import { melodicMinorModes } from "./melodic-minor-modes.ts";
-import { diminished } from "./diminished.ts";
-import { augmented } from "./augmented.ts";
+import { diminishedVariants } from "./diminished-variants.ts";
+import { augmentedVariants } from "./augmented-variants.ts";
 import { otherNoteCollections } from "./other-collections.ts";
 
 export { diatonicModes } from "./diatonic-modes.ts";
@@ -16,8 +16,8 @@ export { minorVariants } from "./minor-variants.ts";
 export { dominantVariants } from "./dominant-variants.ts";
 export { harmonicMinorModes } from "./harmonic-minor-modes.ts";
 export { melodicMinorModes } from "./melodic-minor-modes.ts";
-export { diminished } from "./diminished.ts";
-export { augmented } from "./augmented.ts";
+export { diminishedVariants } from "./diminished-variants.ts";
+export { augmentedVariants } from "./augmented-variants.ts";
 export { otherNoteCollections } from "./other-collections.ts";
 
 export const noteCollections = {
@@ -28,8 +28,8 @@ export const noteCollections = {
   ...dominantVariants,
   ...harmonicMinorModes,
   ...melodicMinorModes,
-  ...diminished,
-  ...augmented,
+  ...diminishedVariants,
+  ...augmentedVariants,
   ...otherNoteCollections,
 } as const;
 
@@ -43,8 +43,8 @@ export const groupedNoteCollections = {
   dominantVariants,
   harmonicMinorModes,
   melodicMinorModes,
-  diminished,
-  augmented,
+  diminishedVariants,
+  augmentedVariants,
   otherNoteCollections,
 } as const;
 
@@ -91,11 +91,11 @@ export const noteCollectionGroupsMetadata: Record<
     description:
       "Seven-note scales derived from the melodic minor scale, each starting on a different scale degree.",
   },
-  diminished: {
+  diminishedVariants: {
     displayName: "Diminished",
     description: "Tense and dissonant chords and scales built on minor thirds.",
   },
-  augmented: {
+  augmentedVariants: {
     displayName: "Augmented",
     description:
       "Unstable and dreamy chords and scales, including classical augmented sixth chords.",

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

@@ -1,5 +1,10 @@
-import type { NoteCollection } from "../../types/note-collections.d.ts";
-const chromatic: NoteCollection = {
+import type {
+  NoteCollection,
+  ScaleCollection,
+} from "../../types/note-collections.d.ts";
+
+const chromatic: ScaleCollection = {
+  category: "scale",
   primaryName: "Chromatic",
   names: ["Chromatic", "Twelve-Tone Scale"],
   intervals: [
@@ -42,7 +47,8 @@ const chromatic: NoteCollection = {
   patternShort: ["H", "H", "H", "H", "H", "H", "H", "H", "H", "H", "H"],
 } as const;
 
-const wholeTone: NoteCollection = {
+const wholeTone: ScaleCollection = {
+  category: "scale",
   primaryName: "Whole Tone Scale",
   names: [
     "Whole Tone Scale",

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

@@ -1,6 +1,8 @@
-import type { NoteCollection } from "../../types/note-collections.d.ts";
+import type { ScaleCollection } from "../../types/note-collections.d.ts";
 
-const majorPentatonic: NoteCollection = {
+const majorPentatonic: ScaleCollection = {
+  category: "scale",
+  rotation: 0,
   primaryName: "Major Pentatonic",
   names: ["Major Pentatonic"],
   intervals: ["1", "2", "3", "5", "6", "8"],
@@ -18,7 +20,9 @@ const majorPentatonic: NoteCollection = {
   patternShort: ["W", "W", "m3", "W", "m3"],
 } as const;
 
-const suspendedPentatonic: NoteCollection = {
+const suspendedPentatonic: ScaleCollection = {
+  category: "scale",
+  rotation: 1,
   primaryName: "Suspended Pentatonic",
   names: ["Suspended Pentatonic", "Egyptian Pentatonic"],
   intervals: ["1", "2", "4", "5", "♭7", "8"],
@@ -29,7 +33,9 @@ const suspendedPentatonic: NoteCollection = {
   patternShort: ["W", "m3", "W", "m3"],
 } as const;
 
-const bluesMinorPentatonic: NoteCollection = {
+const bluesMinorPentatonic: ScaleCollection = {
+  category: "scale",
+  rotation: 2,
   primaryName: "Blues Minor Pentatonic",
   names: ["Blues Minor Pentatonic"],
   intervals: ["1", "♭3", "4", "♭5", "♭7", "8"],
@@ -40,7 +46,9 @@ const bluesMinorPentatonic: NoteCollection = {
   patternShort: ["m3", "W", "H", "m3"],
 } as const;
 
-const bluesMajorPentatonic: NoteCollection = {
+const bluesMajorPentatonic: ScaleCollection = {
+  category: "scale",
+  rotation: 3,
   primaryName: "Blues Major Pentatonic",
   names: ["Blues Major Pentatonic"],
   intervals: ["1", "2", "♭3", "5", "6", "8"],
@@ -51,7 +59,9 @@ const bluesMajorPentatonic: NoteCollection = {
   patternShort: ["W", "H", "M3", "W"],
 } as const;
 
-const minorPentatonic: NoteCollection = {
+const minorPentatonic: ScaleCollection = {
+  category: "scale",
+  rotation: 4,
   primaryName: "Minor Pentatonic",
   names: ["Minor Pentatonic"],
   intervals: ["1", "♭3", "4", "5", "♭7", "8"],
@@ -64,19 +74,8 @@ const minorPentatonic: NoteCollection = {
     "found in many cultures",
     "relative of major pentatonic",
   ],
-  pattern: ["minor third", "whole", "whole", "minor third"],
-  patternShort: ["m3", "W", "W", "m3"],
-} as const;
-
-const dominantPentatonic: NoteCollection = {
-  primaryName: "Dominant Pentatonic",
-  names: ["Dominant Pentatonic"],
-  intervals: ["1", "2", "3", "5", "♭7", "8"],
-  integers: [0, 2, 4, 7, 10],
-  type: ["dominant", "pentatonic", "scale", "gapped scale"],
-  characteristics: ["bluesy", "dominant feel", "mixolydian flavor"],
-  pattern: ["whole", "whole", "minor third", "minor third"],
-  patternShort: ["W", "W", "m3", "m3"],
+  pattern: ["minor third", "whole", "whole", "minor third", "whole"],
+  patternShort: ["m3", "W", "W", "m3", "W"],
 } as const;
 
 export const _pentatonicVariants = {
@@ -85,10 +84,9 @@ export const _pentatonicVariants = {
   bluesMinorPentatonic,
   bluesMajorPentatonic,
   minorPentatonic,
-  dominantPentatonic,
 } as const;
 
 export type PentatonicVariantKey = keyof typeof _pentatonicVariants;
 
-export const pentatonicVariants: Record<PentatonicVariantKey, NoteCollection> =
+export const pentatonicVariants: Record<PentatonicVariantKey, ScaleCollection> =
   _pentatonicVariants;

package/src/mod.ts

@@ -13,28 +13,59 @@
  * import * as music_theory_data from "jsr:@musodojo/music-theory-data";
  *
  * // You can now access all the data and functions.
+ *
  * // The details for the Ionian Diatonic Mode (Major Scale).
  * console.log("ionian details: ", music_theory_data.noteCollections.ionian);
  * // ionian details:  {
- * // 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
- * // ],
- * // rotation: 0,
- * // type: [
- * //   "major.
- * // ...
+ * //   category: "scale",
+ * //   rotation: 0,
+ * //   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"],
  * // }
+ *
  * // Get the notes of a stored chord, or scale.
  * console.log("A harmonic minor: ", music_theory_data.getNoteNamesFromRootAndCollectionKey("A", "harmonicMinor"))
  * // A harmonic minor: ["A", "B", "C", "D", "E", "F", "G♯", "A"]
+ *
+ * // Log the array of all available Note Collection Keys
+ * console.log(Object.keys(music_theory_data.noteCollections));
+ *
+ * // Log the array of all available Grouped Note Collections Keys
+ * console.log(Object.keys(music_theory_data.groupedNoteCollections));
  * ```
  */
 export * from "./data/mod.ts";