@musodojo/music-theory-data 31.0.0 → 32.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/README.md +87 -287
  2. package/esm/src/data/chord-progressions/mod.d.ts +3 -0
  3. package/esm/src/data/chord-progressions/mod.d.ts.map +1 -1
  4. package/esm/src/data/chord-progressions/mod.js +2 -0
  5. package/esm/src/data/chords/mod.d.ts +12 -0
  6. package/esm/src/data/chords/mod.d.ts.map +1 -1
  7. package/esm/src/data/chords/mod.js +1 -0
  8. package/esm/src/data/chromatic.d.ts +2 -0
  9. package/esm/src/data/chromatic.d.ts.map +1 -1
  10. package/esm/src/data/chromatic.js +2 -0
  11. package/esm/src/data/colors/mod.d.ts +14 -0
  12. package/esm/src/data/colors/mod.d.ts.map +1 -1
  13. package/esm/src/data/colors/mod.js +5 -0
  14. package/esm/src/data/note-collections/augmented-variants.d.ts +1 -0
  15. package/esm/src/data/note-collections/augmented-variants.d.ts.map +1 -1
  16. package/esm/src/data/note-collections/augmented-variants.js +4 -2
  17. package/esm/src/data/note-collections/diminished-variants.d.ts +1 -0
  18. package/esm/src/data/note-collections/diminished-variants.d.ts.map +1 -1
  19. package/esm/src/data/note-collections/diminished-variants.js +1 -0
  20. package/esm/src/data/note-collections/dominant-variants.d.ts +1 -0
  21. package/esm/src/data/note-collections/dominant-variants.d.ts.map +1 -1
  22. package/esm/src/data/note-collections/dominant-variants.js +1 -0
  23. package/esm/src/data/note-collections/major-variants.d.ts +1 -0
  24. package/esm/src/data/note-collections/major-variants.d.ts.map +1 -1
  25. package/esm/src/data/note-collections/major-variants.js +1 -0
  26. package/esm/src/data/note-collections/minor-variants.d.ts +1 -0
  27. package/esm/src/data/note-collections/minor-variants.d.ts.map +1 -1
  28. package/esm/src/data/note-collections/minor-variants.js +1 -0
  29. package/esm/src/data/note-collections/other-collections.d.ts +1 -0
  30. package/esm/src/data/note-collections/other-collections.d.ts.map +1 -1
  31. package/esm/src/data/note-collections/other-collections.js +1 -0
  32. package/esm/src/data/note-collections/pentatonic-variants.d.ts +1 -0
  33. package/esm/src/data/note-collections/pentatonic-variants.d.ts.map +1 -1
  34. package/esm/src/data/note-collections/pentatonic-variants.js +1 -0
  35. package/esm/src/data/tunings/bass-guitar-tunings.d.ts +7 -0
  36. package/esm/src/data/tunings/bass-guitar-tunings.d.ts.map +1 -1
  37. package/esm/src/data/tunings/bass-guitar-tunings.js +3 -0
  38. package/esm/src/data/tunings/folk-fretted-string-tunings.d.ts +7 -0
  39. package/esm/src/data/tunings/folk-fretted-string-tunings.d.ts.map +1 -1
  40. package/esm/src/data/tunings/folk-fretted-string-tunings.js +3 -0
  41. package/esm/src/data/tunings/guitar-tunings.d.ts +8 -0
  42. package/esm/src/data/tunings/guitar-tunings.d.ts.map +1 -1
  43. package/esm/src/data/tunings/guitar-tunings.js +3 -0
  44. package/esm/src/data/tunings/orchestral-string-tunings.d.ts +6 -0
  45. package/esm/src/data/tunings/orchestral-string-tunings.d.ts.map +1 -1
  46. package/esm/src/data/tunings/orchestral-string-tunings.js +2 -0
  47. package/esm/src/data/tunings/string-instrument-groups.d.ts +8 -0
  48. package/esm/src/data/tunings/string-instrument-groups.d.ts.map +1 -1
  49. package/esm/src/data/tunings/string-instrument-groups.js +6 -0
  50. package/esm/src/data/tunings/string-instrument-tunings.d.ts +10 -0
  51. package/esm/src/data/tunings/string-instrument-tunings.d.ts.map +1 -1
  52. package/esm/src/data/tunings/string-instrument-tunings.js +5 -0
  53. package/esm/src/mod.d.ts +0 -47
  54. package/esm/src/mod.d.ts.map +1 -1
  55. package/esm/src/mod.js +0 -47
  56. package/esm/src/utils/chord-progressions.d.ts +7 -0
  57. package/esm/src/utils/chord-progressions.d.ts.map +1 -1
  58. package/esm/src/utils/chord-progressions.js +6 -0
  59. package/package.json +1 -1
  60. package/script/src/data/chord-progressions/mod.d.ts +3 -0
  61. package/script/src/data/chord-progressions/mod.d.ts.map +1 -1
  62. package/script/src/data/chord-progressions/mod.js +2 -0
  63. package/script/src/data/chords/mod.d.ts +12 -0
  64. package/script/src/data/chords/mod.d.ts.map +1 -1
  65. package/script/src/data/chords/mod.js +1 -0
  66. package/script/src/data/chromatic.d.ts +2 -0
  67. package/script/src/data/chromatic.d.ts.map +1 -1
  68. package/script/src/data/chromatic.js +2 -0
  69. package/script/src/data/colors/mod.d.ts +14 -0
  70. package/script/src/data/colors/mod.d.ts.map +1 -1
  71. package/script/src/data/colors/mod.js +5 -0
  72. package/script/src/data/note-collections/augmented-variants.d.ts +1 -0
  73. package/script/src/data/note-collections/augmented-variants.d.ts.map +1 -1
  74. package/script/src/data/note-collections/augmented-variants.js +4 -2
  75. package/script/src/data/note-collections/diminished-variants.d.ts +1 -0
  76. package/script/src/data/note-collections/diminished-variants.d.ts.map +1 -1
  77. package/script/src/data/note-collections/diminished-variants.js +1 -0
  78. package/script/src/data/note-collections/dominant-variants.d.ts +1 -0
  79. package/script/src/data/note-collections/dominant-variants.d.ts.map +1 -1
  80. package/script/src/data/note-collections/dominant-variants.js +1 -0
  81. package/script/src/data/note-collections/major-variants.d.ts +1 -0
  82. package/script/src/data/note-collections/major-variants.d.ts.map +1 -1
  83. package/script/src/data/note-collections/major-variants.js +1 -0
  84. package/script/src/data/note-collections/minor-variants.d.ts +1 -0
  85. package/script/src/data/note-collections/minor-variants.d.ts.map +1 -1
  86. package/script/src/data/note-collections/minor-variants.js +1 -0
  87. package/script/src/data/note-collections/other-collections.d.ts +1 -0
  88. package/script/src/data/note-collections/other-collections.d.ts.map +1 -1
  89. package/script/src/data/note-collections/other-collections.js +1 -0
  90. package/script/src/data/note-collections/pentatonic-variants.d.ts +1 -0
  91. package/script/src/data/note-collections/pentatonic-variants.d.ts.map +1 -1
  92. package/script/src/data/note-collections/pentatonic-variants.js +1 -0
  93. package/script/src/data/tunings/bass-guitar-tunings.d.ts +7 -0
  94. package/script/src/data/tunings/bass-guitar-tunings.d.ts.map +1 -1
  95. package/script/src/data/tunings/bass-guitar-tunings.js +3 -0
  96. package/script/src/data/tunings/folk-fretted-string-tunings.d.ts +7 -0
  97. package/script/src/data/tunings/folk-fretted-string-tunings.d.ts.map +1 -1
  98. package/script/src/data/tunings/folk-fretted-string-tunings.js +3 -0
  99. package/script/src/data/tunings/guitar-tunings.d.ts +8 -0
  100. package/script/src/data/tunings/guitar-tunings.d.ts.map +1 -1
  101. package/script/src/data/tunings/guitar-tunings.js +3 -0
  102. package/script/src/data/tunings/orchestral-string-tunings.d.ts +6 -0
  103. package/script/src/data/tunings/orchestral-string-tunings.d.ts.map +1 -1
  104. package/script/src/data/tunings/orchestral-string-tunings.js +2 -0
  105. package/script/src/data/tunings/string-instrument-groups.d.ts +8 -0
  106. package/script/src/data/tunings/string-instrument-groups.d.ts.map +1 -1
  107. package/script/src/data/tunings/string-instrument-groups.js +6 -0
  108. package/script/src/data/tunings/string-instrument-tunings.d.ts +10 -0
  109. package/script/src/data/tunings/string-instrument-tunings.d.ts.map +1 -1
  110. package/script/src/data/tunings/string-instrument-tunings.js +5 -0
  111. package/script/src/mod.d.ts +0 -47
  112. package/script/src/mod.d.ts.map +1 -1
  113. package/script/src/mod.js +0 -47
  114. package/script/src/utils/chord-progressions.d.ts +7 -0
  115. package/script/src/utils/chord-progressions.d.ts.map +1 -1
  116. package/script/src/utils/chord-progressions.js +6 -0
@@ -1,17 +1,21 @@
1
1
  import { noteLabelCollections, } from "../labels/note-label-collections.js";
2
+ /** The default note label collection key used for each note color mode. */
2
3
  export const defaultNoteColorLabelCollectionKeys = {
3
4
  absolute: "noteNamesFlat",
4
5
  relative: "intervalsFlat",
5
6
  };
7
+ /** Returns the default label collection key for an absolute or relative color mode. */
6
8
  export function getDefaultNoteColorLabelCollectionKey(mode) {
7
9
  return defaultNoteColorLabelCollectionKeys[mode];
8
10
  }
11
+ /** Returns the explicit or default label collection key for a note color collection. */
9
12
  export function getNoteColorLabelCollectionKey(collection) {
10
13
  if (collection.labelCollectionKey) {
11
14
  return collection.labelCollectionKey;
12
15
  }
13
16
  return getDefaultNoteColorLabelCollectionKey(collection.mode);
14
17
  }
18
+ /** Returns the 12 labels that should be displayed with a note color collection. */
15
19
  export function getNoteColorLabels(collection) {
16
20
  return noteLabelCollections[getNoteColorLabelCollectionKey(collection)]
17
21
  .labels;
@@ -102,4 +106,5 @@ const _colorCollections = {
102
106
  ],
103
107
  },
104
108
  };
109
+ /** Built-in absolute and relative note color palettes. */
105
110
  export const colorCollections = _colorCollections;
@@ -5,5 +5,6 @@ export declare const _augmentedVariants: {
5
5
  readonly augmentedMajor7: ChordCollection;
6
6
  };
7
7
  export type AugmentedVariantKey = keyof typeof _augmentedVariants;
8
+ /** Built-in augmented-family chord collections keyed by collection id. */
8
9
  export declare const augmentedVariants: Record<AugmentedVariantKey, ChordCollection>;
9
10
  //# sourceMappingURL=augmented-variants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"augmented-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/augmented-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAqDpE,eAAO,MAAM,kBAAkB;;;;CAIrB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,kBAAkB,CAAC;AAElE,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,mBAAmB,EAAE,eAAe,CACvD,CAAC"}
1
+ {"version":3,"file":"augmented-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/augmented-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAsDpE,eAAO,MAAM,kBAAkB;;;;CAIrB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,kBAAkB,CAAC;AAElE,0EAA0E;AAC1E,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,mBAAmB,EAAE,eAAe,CACvD,CAAC"}
@@ -24,9 +24,10 @@ const augmented7 = {
24
24
  };
25
25
  const augmentedMajor7 = {
26
26
  category: "chord",
27
- mostSimilarScale: "ionianSharp5",
28
- primaryName: "+M7",
27
+ mostSimilarScale: "ionian",
28
+ primaryName: "augM7",
29
29
  names: [
30
+ "augM7",
30
31
  "+M7",
31
32
  "M7♯5",
32
33
  "maj7♯5",
@@ -51,4 +52,5 @@ export const _augmentedVariants = {
51
52
  augmented7,
52
53
  augmentedMajor7,
53
54
  };
55
+ /** Built-in augmented-family chord collections keyed by collection id. */
54
56
  export const augmentedVariants = _augmentedVariants;
@@ -7,5 +7,6 @@ export declare const _diminishedVariants: {
7
7
  readonly halfWholeDiminished: ModalScaleCollection;
8
8
  };
9
9
  export type DiminishedVariantKey = keyof typeof _diminishedVariants;
10
+ /** Built-in diminished chord and scale collections keyed by collection id. */
10
11
  export declare const diminishedVariants: Record<DiminishedVariantKey, NoteCollection>;
11
12
  //# sourceMappingURL=diminished-variants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"diminished-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/diminished-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,cAAc,EACf,MAAM,8BAA8B,CAAC;AA4EtC,eAAO,MAAM,mBAAmB;;;;;;CAMtB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAEpE,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,oBAAoB,EAAE,cAAc,CACvD,CAAC"}
1
+ {"version":3,"file":"diminished-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/diminished-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,cAAc,EACf,MAAM,8BAA8B,CAAC;AA4EtC,eAAO,MAAM,mBAAmB;;;;;;CAMtB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAEpE,8EAA8E;AAC9E,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,oBAAoB,EAAE,cAAc,CACvD,CAAC"}
@@ -74,4 +74,5 @@ export const _diminishedVariants = {
74
74
  wholeHalfDiminished,
75
75
  halfWholeDiminished,
76
76
  };
77
+ /** Built-in diminished chord and scale collections keyed by collection id. */
77
78
  export const diminishedVariants = _diminishedVariants;
@@ -7,5 +7,6 @@ export declare const _dominantVariants: {
7
7
  readonly dominantPentatonic: NonModalScaleCollection;
8
8
  };
9
9
  export type DominantVariantKey = keyof typeof _dominantVariants;
10
+ /** Built-in dominant-family chord and scale collections keyed by collection id. */
10
11
  export declare const dominantVariants: Record<DominantVariantKey, NoteCollection>;
11
12
  //# sourceMappingURL=dominant-variants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"dominant-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/dominant-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,uBAAuB,EACvB,cAAc,EACf,MAAM,8BAA8B,CAAC;AAwHtC,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,MAAM,OAAO,iBAAiB,CAAC;AAEhE,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,kBAAkB,EAAE,cAAc,CACrD,CAAC"}
1
+ {"version":3,"file":"dominant-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/dominant-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,uBAAuB,EACvB,cAAc,EACf,MAAM,8BAA8B,CAAC;AAwHtC,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,MAAM,OAAO,iBAAiB,CAAC;AAEhE,mFAAmF;AACnF,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,kBAAkB,EAAE,cAAc,CACrD,CAAC"}
@@ -118,4 +118,5 @@ export const _dominantVariants = {
118
118
  dominant13,
119
119
  dominantPentatonic,
120
120
  };
121
+ /** Built-in dominant-family chord and scale collections keyed by collection id. */
121
122
  export const dominantVariants = _dominantVariants;
@@ -8,5 +8,6 @@ export declare const _majorVariants: {
8
8
  readonly major6Add9: ChordCollection;
9
9
  };
10
10
  export type MajorVariantKey = keyof typeof _majorVariants;
11
+ /** Built-in major-family chord collections keyed by collection id. */
11
12
  export declare const majorVariants: Record<MajorVariantKey, ChordCollection>;
12
13
  //# sourceMappingURL=major-variants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"major-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/major-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AA2HpE,eAAO,MAAM,cAAc;;;;;;;CAOjB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,cAAc,CAAC;AAE1D,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,eAAe,EAAE,eAAe,CACnD,CAAC"}
1
+ {"version":3,"file":"major-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/major-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AA2HpE,eAAO,MAAM,cAAc;;;;;;;CAOjB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,cAAc,CAAC;AAE1D,sEAAsE;AACtE,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,eAAe,EAAE,eAAe,CACnD,CAAC"}
@@ -121,4 +121,5 @@ export const _majorVariants = {
121
121
  majorAdd9,
122
122
  major6Add9,
123
123
  };
124
+ /** Built-in major-family chord collections keyed by collection id. */
124
125
  export const majorVariants = _majorVariants;
@@ -9,5 +9,6 @@ export declare const _minorVariants: {
9
9
  readonly minor6Add9: ChordCollection;
10
10
  };
11
11
  export type MinorVariantKey = keyof typeof _minorVariants;
12
+ /** Built-in minor-family chord collections keyed by collection id. */
12
13
  export declare const minorVariants: Record<MinorVariantKey, ChordCollection>;
13
14
  //# sourceMappingURL=minor-variants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"minor-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/minor-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAoHpE,eAAO,MAAM,cAAc;;;;;;;;CAQjB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,cAAc,CAAC;AAE1D,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,eAAe,EAAE,eAAe,CACnD,CAAC"}
1
+ {"version":3,"file":"minor-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/minor-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAoHpE,eAAO,MAAM,cAAc;;;;;;;;CAQjB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,cAAc,CAAC;AAE1D,sEAAsE;AACtE,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,eAAe,EAAE,eAAe,CACnD,CAAC"}
@@ -114,4 +114,5 @@ export const _minorVariants = {
114
114
  minorAdd9,
115
115
  minor6Add9,
116
116
  };
117
+ /** Built-in minor-family chord collections keyed by collection id. */
117
118
  export const minorVariants = _minorVariants;
@@ -9,5 +9,6 @@ export declare const _otherNoteCollections: {
9
9
  readonly wholeTone: NonModalScaleCollection;
10
10
  };
11
11
  export type OtherNoteCollectionKey = keyof typeof _otherNoteCollections;
12
+ /** Miscellaneous built-in note collections keyed by collection id. */
12
13
  export declare const otherNoteCollections: Record<OtherNoteCollectionKey, NoteCollection>;
13
14
  //# sourceMappingURL=other-collections.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"other-collections.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/other-collections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACvB,cAAc,EACd,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AAqItC,eAAO,MAAM,qBAAqB;;;;;;;;CAQxB,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,qBAAqB,CAAC;AAExE,eAAO,MAAM,oBAAoB,EAAE,MAAM,CACvC,sBAAsB,EACtB,cAAc,CACS,CAAC"}
1
+ {"version":3,"file":"other-collections.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/other-collections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACvB,cAAc,EACd,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AAqItC,eAAO,MAAM,qBAAqB;;;;;;;;CAQxB,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,qBAAqB,CAAC;AAExE,sEAAsE;AACtE,eAAO,MAAM,oBAAoB,EAAE,MAAM,CACvC,sBAAsB,EACtB,cAAc,CACS,CAAC"}
@@ -131,4 +131,5 @@ export const _otherNoteCollections = {
131
131
  chromatic,
132
132
  wholeTone,
133
133
  };
134
+ /** Miscellaneous built-in note collections keyed by collection id. */
134
135
  export const otherNoteCollections = _otherNoteCollections;
@@ -7,5 +7,6 @@ export declare const _pentatonicVariants: {
7
7
  readonly minorPentatonic: ModalScaleCollection;
8
8
  };
9
9
  export type PentatonicVariantKey = keyof typeof _pentatonicVariants;
10
+ /** Built-in pentatonic scale variants keyed by collection id. */
10
11
  export declare const pentatonicVariants: Record<PentatonicVariantKey, ModalScaleCollection>;
11
12
  //# sourceMappingURL=pentatonic-variants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"pentatonic-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/pentatonic-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AA0FzE,eAAO,MAAM,mBAAmB;;;;;;CAMtB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAEpE,eAAO,MAAM,kBAAkB,EAAE,MAAM,CACrC,oBAAoB,EACpB,oBAAoB,CACC,CAAC"}
1
+ {"version":3,"file":"pentatonic-variants.d.ts","sourceRoot":"","sources":["../../../../src/src/data/note-collections/pentatonic-variants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AA0FzE,eAAO,MAAM,mBAAmB;;;;;;CAMtB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAEpE,iEAAiE;AACjE,eAAO,MAAM,kBAAkB,EAAE,MAAM,CACrC,oBAAoB,EACpB,oBAAoB,CACC,CAAC"}
@@ -88,4 +88,5 @@ export const _pentatonicVariants = {
88
88
  bluesMajorPentatonic,
89
89
  minorPentatonic,
90
90
  };
91
+ /** Built-in pentatonic scale variants keyed by collection id. */
91
92
  export const pentatonicVariants = _pentatonicVariants;
@@ -1,14 +1,21 @@
1
1
  import type { StringInstrumentKey, StringInstrumentTuning } from "../../types/string-instruments";
2
+ /** Instrument keys covered by the bass guitar tuning registry. */
2
3
  export type BassGuitarInstrumentKey = Extract<StringInstrumentKey, "bassGuitar">;
3
4
  declare const _bassGuitarTunings: {
4
5
  readonly bassStandardEadg: StringInstrumentTuning;
5
6
  readonly bassFiveStringBeadg: StringInstrumentTuning;
6
7
  };
8
+ /** A key for one of the built-in bass guitar tunings. */
7
9
  export type BassGuitarTuningKey = keyof typeof _bassGuitarTunings;
10
+ /** Dictionary of built-in bass guitar tunings keyed by tuning id. */
8
11
  export type BassGuitarTunings = Record<BassGuitarTuningKey, StringInstrumentTuning>;
12
+ /** Built-in bass guitar tunings. */
9
13
  export declare const bassGuitarTunings: BassGuitarTunings;
14
+ /** Ordered keys for the built-in bass guitar tunings. */
10
15
  export declare const bassGuitarTuningKeys: readonly BassGuitarTuningKey[];
16
+ /** Bass guitar tuning keys grouped by instrument. */
11
17
  export type BassGuitarTuningKeysByInstrument = Readonly<Record<BassGuitarInstrumentKey, readonly BassGuitarTuningKey[]>>;
18
+ /** Built-in bass guitar tuning keys grouped by instrument. */
12
19
  export declare const bassGuitarTuningKeysByInstrument: BassGuitarTuningKeysByInstrument;
13
20
  export {};
14
21
  //# sourceMappingURL=bass-guitar-tunings.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"bass-guitar-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/bass-guitar-tunings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAC3C,mBAAmB,EACnB,YAAY,CACb,CAAC;AAkBF,QAAA,MAAM,kBAAkB;;;CAGd,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,kBAAkB,CAAC;AAElE,MAAM,MAAM,iBAAiB,GAAG,MAAM,CACpC,mBAAmB,EACnB,sBAAsB,CACvB,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,iBAAsC,CAAC;AAEvE,eAAO,MAAM,oBAAoB,EAAE,SAAS,mBAAmB,EAE5B,CAAC;AAEpC,MAAM,MAAM,gCAAgC,GAAG,QAAQ,CACrD,MAAM,CAAC,uBAAuB,EAAE,SAAS,mBAAmB,EAAE,CAAC,CAChE,CAAC;AAEF,eAAO,MAAM,gCAAgC,EAC3C,gCAEC,CAAC"}
1
+ {"version":3,"file":"bass-guitar-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/bass-guitar-tunings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,kEAAkE;AAClE,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAC3C,mBAAmB,EACnB,YAAY,CACb,CAAC;AAkBF,QAAA,MAAM,kBAAkB;;;CAGd,CAAC;AAEX,yDAAyD;AACzD,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,kBAAkB,CAAC;AAElE,qEAAqE;AACrE,MAAM,MAAM,iBAAiB,GAAG,MAAM,CACpC,mBAAmB,EACnB,sBAAsB,CACvB,CAAC;AAEF,oCAAoC;AACpC,eAAO,MAAM,iBAAiB,EAAE,iBAAsC,CAAC;AAEvE,yDAAyD;AACzD,eAAO,MAAM,oBAAoB,EAAE,SAAS,mBAAmB,EAE5B,CAAC;AAEpC,qDAAqD;AACrD,MAAM,MAAM,gCAAgC,GAAG,QAAQ,CACrD,MAAM,CAAC,uBAAuB,EAAE,SAAS,mBAAmB,EAAE,CAAC,CAChE,CAAC;AAEF,8DAA8D;AAC9D,eAAO,MAAM,gCAAgC,EAC3C,gCAEC,CAAC"}
@@ -16,8 +16,11 @@ const _bassGuitarTunings = {
16
16
  bassStandardEadg,
17
17
  bassFiveStringBeadg,
18
18
  };
19
+ /** Built-in bass guitar tunings. */
19
20
  export const bassGuitarTunings = _bassGuitarTunings;
21
+ /** Ordered keys for the built-in bass guitar tunings. */
20
22
  export const bassGuitarTuningKeys = Object.keys(_bassGuitarTunings);
23
+ /** Built-in bass guitar tuning keys grouped by instrument. */
21
24
  export const bassGuitarTuningKeysByInstrument = {
22
25
  bassGuitar: bassGuitarTuningKeys,
23
26
  };
@@ -1,14 +1,21 @@
1
1
  import type { StringInstrumentKey, StringInstrumentTuning } from "../../types/string-instruments";
2
+ /** Instrument keys covered by the folk and fretted string tuning registry. */
2
3
  export type FolkFrettedStringInstrumentKey = Extract<StringInstrumentKey, "mandolin" | "ukulele">;
3
4
  declare const _folkFrettedStringTunings: {
4
5
  readonly mandolinStandardGdae: StringInstrumentTuning;
5
6
  readonly ukuleleStandardGcea: StringInstrumentTuning;
6
7
  };
8
+ /** A key for one of the built-in folk or fretted string tunings. */
7
9
  export type FolkFrettedStringTuningKey = keyof typeof _folkFrettedStringTunings;
10
+ /** Dictionary of built-in folk and fretted string tunings keyed by tuning id. */
8
11
  export type FolkFrettedStringTunings = Record<FolkFrettedStringTuningKey, StringInstrumentTuning>;
12
+ /** Built-in mandolin and ukulele tunings. */
9
13
  export declare const folkFrettedStringTunings: FolkFrettedStringTunings;
14
+ /** Ordered keys for the built-in folk and fretted string tunings. */
10
15
  export declare const folkFrettedStringTuningKeys: readonly FolkFrettedStringTuningKey[];
16
+ /** Folk and fretted string tuning keys grouped by instrument. */
11
17
  export type FolkFrettedStringTuningKeysByInstrument = Readonly<Record<FolkFrettedStringInstrumentKey, readonly FolkFrettedStringTuningKey[]>>;
18
+ /** Built-in folk and fretted string tuning keys grouped by instrument. */
12
19
  export declare const folkFrettedStringTuningKeysByInstrument: FolkFrettedStringTuningKeysByInstrument;
13
20
  export {};
14
21
  //# sourceMappingURL=folk-fretted-string-tunings.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"folk-fretted-string-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/folk-fretted-string-tunings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,MAAM,MAAM,8BAA8B,GAAG,OAAO,CAClD,mBAAmB,EACnB,UAAU,GAAG,SAAS,CACvB,CAAC;AAwBF,QAAA,MAAM,yBAAyB;;;CAGrB,CAAC;AAEX,MAAM,MAAM,0BAA0B,GAAG,MAAM,OAAO,yBAAyB,CAAC;AAEhF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAC3C,0BAA0B,EAC1B,sBAAsB,CACvB,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,wBACZ,CAAC;AAE5B,eAAO,MAAM,2BAA2B,EACtC,SAAS,0BAA0B,EAEO,CAAC;AAE7C,MAAM,MAAM,uCAAuC,GAAG,QAAQ,CAC5D,MAAM,CAAC,8BAA8B,EAAE,SAAS,0BAA0B,EAAE,CAAC,CAC9E,CAAC;AAEF,eAAO,MAAM,uCAAuC,EAClD,uCAGC,CAAC"}
1
+ {"version":3,"file":"folk-fretted-string-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/folk-fretted-string-tunings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,8EAA8E;AAC9E,MAAM,MAAM,8BAA8B,GAAG,OAAO,CAClD,mBAAmB,EACnB,UAAU,GAAG,SAAS,CACvB,CAAC;AAwBF,QAAA,MAAM,yBAAyB;;;CAGrB,CAAC;AAEX,oEAAoE;AACpE,MAAM,MAAM,0BAA0B,GAAG,MAAM,OAAO,yBAAyB,CAAC;AAEhF,iFAAiF;AACjF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAC3C,0BAA0B,EAC1B,sBAAsB,CACvB,CAAC;AAEF,6CAA6C;AAC7C,eAAO,MAAM,wBAAwB,EAAE,wBACZ,CAAC;AAE5B,qEAAqE;AACrE,eAAO,MAAM,2BAA2B,EACtC,SAAS,0BAA0B,EAEO,CAAC;AAE7C,iEAAiE;AACjE,MAAM,MAAM,uCAAuC,GAAG,QAAQ,CAC5D,MAAM,CAAC,8BAA8B,EAAE,SAAS,0BAA0B,EAAE,CAAC,CAC9E,CAAC;AAEF,0EAA0E;AAC1E,eAAO,MAAM,uCAAuC,EAClD,uCAGC,CAAC"}
@@ -22,8 +22,11 @@ const _folkFrettedStringTunings = {
22
22
  mandolinStandardGdae,
23
23
  ukuleleStandardGcea,
24
24
  };
25
+ /** Built-in mandolin and ukulele tunings. */
25
26
  export const folkFrettedStringTunings = _folkFrettedStringTunings;
27
+ /** Ordered keys for the built-in folk and fretted string tunings. */
26
28
  export const folkFrettedStringTuningKeys = Object.keys(_folkFrettedStringTunings);
29
+ /** Built-in folk and fretted string tuning keys grouped by instrument. */
27
30
  export const folkFrettedStringTuningKeysByInstrument = {
28
31
  mandolin: ["mandolinStandardGdae"],
29
32
  ukulele: ["ukuleleStandardGcea"],
@@ -13,10 +13,15 @@ declare const _guitarTunings: {
13
13
  readonly guitarOpenDMinor: StringInstrumentTuning;
14
14
  readonly guitarJacobCollierTuning: StringInstrumentTuning;
15
15
  };
16
+ /** A key for one of the built-in guitar tunings. */
16
17
  export type GuitarTuningKey = keyof typeof _guitarTunings;
18
+ /** Dictionary of built-in guitar tunings keyed by tuning id. */
17
19
  export type GuitarTunings = Record<GuitarTuningKey, StringInstrumentTuning>;
20
+ /** Built-in guitar tunings. */
18
21
  export declare const guitarTunings: GuitarTunings;
22
+ /** Ordered keys for the built-in guitar tunings. */
19
23
  export declare const guitarTuningKeys: readonly GuitarTuningKey[];
24
+ /** A named group of related guitar tunings. */
20
25
  export interface GuitarTuningGroup {
21
26
  displayName: string;
22
27
  tuningKeys: readonly GuitarTuningKey[];
@@ -27,8 +32,11 @@ declare const _guitarTuningGroups: {
27
32
  readonly modal: GuitarTuningGroup;
28
33
  readonly open: GuitarTuningGroup;
29
34
  };
35
+ /** A key for one of the built-in guitar tuning groups. */
30
36
  export type GuitarTuningGroupKey = keyof typeof _guitarTuningGroups;
37
+ /** Dictionary of built-in guitar tuning groups keyed by group id. */
31
38
  export type GuitarTuningGroups = Record<GuitarTuningGroupKey, GuitarTuningGroup>;
39
+ /** Built-in guitar tuning groups for standard, drop, modal, and open tunings. */
32
40
  export declare const guitarTuningGroups: GuitarTuningGroups;
33
41
  export {};
34
42
  //# sourceMappingURL=guitar-tunings.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"guitar-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/guitar-tunings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAwG7E,QAAA,MAAM,cAAc;;;;;;;;;;;;;CAaV,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,cAAc,CAAC;AAE1D,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,eAAe,EAAE,sBAAsB,CAAC,CAAC;AAE5E,eAAO,MAAM,aAAa,EAAE,aAA8B,CAAC;AAE3D,eAAO,MAAM,gBAAgB,EAAE,SAAS,eAAe,EAExB,CAAC;AAEhC,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,SAAS,eAAe,EAAE,CAAC;CACxC;AAgCD,QAAA,MAAM,mBAAmB;;;;;CAKf,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAEpE,MAAM,MAAM,kBAAkB,GAAG,MAAM,CACrC,oBAAoB,EACpB,iBAAiB,CAClB,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,kBAAwC,CAAC"}
1
+ {"version":3,"file":"guitar-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/guitar-tunings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAwG7E,QAAA,MAAM,cAAc;;;;;;;;;;;;;CAaV,CAAC;AAEX,oDAAoD;AACpD,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,cAAc,CAAC;AAE1D,gEAAgE;AAChE,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,eAAe,EAAE,sBAAsB,CAAC,CAAC;AAE5E,+BAA+B;AAC/B,eAAO,MAAM,aAAa,EAAE,aAA8B,CAAC;AAE3D,oDAAoD;AACpD,eAAO,MAAM,gBAAgB,EAAE,SAAS,eAAe,EAExB,CAAC;AAEhC,+CAA+C;AAC/C,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,SAAS,eAAe,EAAE,CAAC;CACxC;AAgCD,QAAA,MAAM,mBAAmB;;;;;CAKf,CAAC;AAEX,0DAA0D;AAC1D,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAEpE,qEAAqE;AACrE,MAAM,MAAM,kBAAkB,GAAG,MAAM,CACrC,oBAAoB,EACpB,iBAAiB,CAClB,CAAC;AAEF,iFAAiF;AACjF,eAAO,MAAM,kBAAkB,EAAE,kBAAwC,CAAC"}
@@ -102,7 +102,9 @@ const _guitarTunings = {
102
102
  guitarOpenDMinor,
103
103
  guitarJacobCollierTuning,
104
104
  };
105
+ /** Built-in guitar tunings. */
105
106
  export const guitarTunings = _guitarTunings;
107
+ /** Ordered keys for the built-in guitar tunings. */
106
108
  export const guitarTuningKeys = Object.keys(_guitarTunings);
107
109
  const standardGuitarTuningGroup = {
108
110
  displayName: "Standard",
@@ -136,4 +138,5 @@ const _guitarTuningGroups = {
136
138
  modal: modalGuitarTuningGroup,
137
139
  open: openGuitarTuningGroup,
138
140
  };
141
+ /** Built-in guitar tuning groups for standard, drop, modal, and open tunings. */
139
142
  export const guitarTuningGroups = _guitarTuningGroups;
@@ -1,5 +1,6 @@
1
1
  import type { StringInstrumentKey, StringInstrumentTuning } from "../../types/string-instruments";
2
2
  export { orchestralStringsInstrumentGroup } from "./string-instrument-groups.js";
3
+ /** Instrument keys covered by the orchestral string tuning registry. */
3
4
  export type OrchestralStringInstrumentKey = Extract<StringInstrumentKey, "violin" | "viola" | "cello" | "doubleBass">;
4
5
  declare const _orchestralStringTunings: {
5
6
  readonly violinStandardGdae: StringInstrumentTuning;
@@ -7,9 +8,14 @@ declare const _orchestralStringTunings: {
7
8
  readonly celloStandardCgda: StringInstrumentTuning;
8
9
  readonly doubleBassStandardEadg: StringInstrumentTuning;
9
10
  };
11
+ /** A key for one of the built-in orchestral string tunings. */
10
12
  export type OrchestralStringTuningKey = keyof typeof _orchestralStringTunings;
13
+ /** Dictionary of built-in orchestral string tunings keyed by tuning id. */
11
14
  export type OrchestralStringTunings = Record<OrchestralStringTuningKey, StringInstrumentTuning>;
15
+ /** Built-in violin, viola, cello, and double bass tunings. */
12
16
  export declare const orchestralStringTunings: OrchestralStringTunings;
17
+ /** Orchestral string tuning keys grouped by instrument. */
13
18
  export type OrchestralStringTuningKeysByInstrument = Readonly<Record<OrchestralStringInstrumentKey, readonly OrchestralStringTuningKey[]>>;
19
+ /** Built-in orchestral string tuning keys grouped by instrument. */
14
20
  export declare const orchestralStringTuningKeysByInstrument: OrchestralStringTuningKeysByInstrument;
15
21
  //# sourceMappingURL=orchestral-string-tunings.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"orchestral-string-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/orchestral-string-tunings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,gCAAgC,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,MAAM,6BAA6B,GAAG,OAAO,CACjD,mBAAmB,EACnB,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,CAC5C,CAAC;AAkCF,QAAA,MAAM,wBAAwB;;;;;CAKpB,CAAC;AAEX,MAAM,MAAM,yBAAyB,GAAG,MAAM,OAAO,wBAAwB,CAAC;AAE9E,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAC1C,yBAAyB,EACzB,sBAAsB,CACvB,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,uBACZ,CAAC;AAE3B,MAAM,MAAM,sCAAsC,GAAG,QAAQ,CAC3D,MAAM,CAAC,6BAA6B,EAAE,SAAS,yBAAyB,EAAE,CAAC,CAC5E,CAAC;AAEF,eAAO,MAAM,sCAAsC,EACjD,sCAKC,CAAC"}
1
+ {"version":3,"file":"orchestral-string-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/orchestral-string-tunings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,gCAAgC,EAAE,MAAM,+BAA+B,CAAC;AAEjF,wEAAwE;AACxE,MAAM,MAAM,6BAA6B,GAAG,OAAO,CACjD,mBAAmB,EACnB,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,CAC5C,CAAC;AAkCF,QAAA,MAAM,wBAAwB;;;;;CAKpB,CAAC;AAEX,+DAA+D;AAC/D,MAAM,MAAM,yBAAyB,GAAG,MAAM,OAAO,wBAAwB,CAAC;AAE9E,2EAA2E;AAC3E,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAC1C,yBAAyB,EACzB,sBAAsB,CACvB,CAAC;AAEF,8DAA8D;AAC9D,eAAO,MAAM,uBAAuB,EAAE,uBACZ,CAAC;AAE3B,2DAA2D;AAC3D,MAAM,MAAM,sCAAsC,GAAG,QAAQ,CAC3D,MAAM,CAAC,6BAA6B,EAAE,SAAS,yBAAyB,EAAE,CAAC,CAC5E,CAAC;AAEF,oEAAoE;AACpE,eAAO,MAAM,sCAAsC,EACjD,sCAKC,CAAC"}
@@ -33,7 +33,9 @@ const _orchestralStringTunings = {
33
33
  celloStandardCgda,
34
34
  doubleBassStandardEadg,
35
35
  };
36
+ /** Built-in violin, viola, cello, and double bass tunings. */
36
37
  export const orchestralStringTunings = _orchestralStringTunings;
38
+ /** Built-in orchestral string tuning keys grouped by instrument. */
37
39
  export const orchestralStringTuningKeysByInstrument = {
38
40
  violin: ["violinStandardGdae"],
39
41
  viola: ["violaStandardCgda"],
@@ -1,7 +1,11 @@
1
1
  import type { StringInstrumentGroup } from "../../types/string-instruments";
2
+ /** Curated group for guitar tunings and fretboard use cases. */
2
3
  export declare const guitarInstrumentGroup: StringInstrumentGroup;
4
+ /** Curated group for bass guitar tunings and fretboard use cases. */
3
5
  export declare const bassInstrumentGroup: StringInstrumentGroup;
6
+ /** Curated group for mandolin, ukulele, and similar fretted strings. */
4
7
  export declare const folkAndFrettedStringsInstrumentGroup: StringInstrumentGroup;
8
+ /** Curated group for violin, viola, cello, and double bass. */
5
9
  export declare const orchestralStringsInstrumentGroup: StringInstrumentGroup;
6
10
  declare const _stringInstrumentGroups: {
7
11
  readonly guitar: StringInstrumentGroup;
@@ -9,9 +13,13 @@ declare const _stringInstrumentGroups: {
9
13
  readonly folkAndFrettedStrings: StringInstrumentGroup;
10
14
  readonly orchestralStrings: StringInstrumentGroup;
11
15
  };
16
+ /** A key for one of the built-in string instrument groups. */
12
17
  export type StringInstrumentGroupKey = keyof typeof _stringInstrumentGroups;
18
+ /** Dictionary of built-in string instrument groups keyed by group id. */
13
19
  export type StringInstrumentGroups = Record<StringInstrumentGroupKey, StringInstrumentGroup>;
20
+ /** Built-in string instrument groups for navigation and filtering. */
14
21
  export declare const stringInstrumentGroups: StringInstrumentGroups;
22
+ /** Ordered keys for the built-in string instrument groups. */
15
23
  export declare const stringInstrumentGroupKeys: readonly StringInstrumentGroupKey[];
16
24
  export {};
17
25
  //# sourceMappingURL=string-instrument-groups.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"string-instrument-groups.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/string-instrument-groups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAE5E,eAAO,MAAM,qBAAqB,EAAE,qBAK1B,CAAC;AAEX,eAAO,MAAM,mBAAmB,EAAE,qBAKxB,CAAC;AAEX,eAAO,MAAM,oCAAoC,EAAE,qBAKzC,CAAC;AAEX,eAAO,MAAM,gCAAgC,EAAE,qBAKrC,CAAC;AAEX,QAAA,MAAM,uBAAuB;;;;;CAKnB,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAAG,MAAM,OAAO,uBAAuB,CAAC;AAE5E,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,wBAAwB,EACxB,qBAAqB,CACtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBACZ,CAAC;AAE1B,eAAO,MAAM,yBAAyB,EAAE,SAAS,wBAAwB,EACI,CAAC"}
1
+ {"version":3,"file":"string-instrument-groups.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/string-instrument-groups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAE5E,gEAAgE;AAChE,eAAO,MAAM,qBAAqB,EAAE,qBAK1B,CAAC;AAEX,qEAAqE;AACrE,eAAO,MAAM,mBAAmB,EAAE,qBAKxB,CAAC;AAEX,wEAAwE;AACxE,eAAO,MAAM,oCAAoC,EAAE,qBAKzC,CAAC;AAEX,+DAA+D;AAC/D,eAAO,MAAM,gCAAgC,EAAE,qBAKrC,CAAC;AAEX,QAAA,MAAM,uBAAuB;;;;;CAKnB,CAAC;AAEX,8DAA8D;AAC9D,MAAM,MAAM,wBAAwB,GAAG,MAAM,OAAO,uBAAuB,CAAC;AAE5E,yEAAyE;AACzE,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,wBAAwB,EACxB,qBAAqB,CACtB,CAAC;AAEF,sEAAsE;AACtE,eAAO,MAAM,sBAAsB,EAAE,sBACZ,CAAC;AAE1B,8DAA8D;AAC9D,eAAO,MAAM,yBAAyB,EAAE,SAAS,wBAAwB,EACI,CAAC"}
@@ -1,18 +1,22 @@
1
+ /** Curated group for guitar tunings and fretboard use cases. */
1
2
  export const guitarInstrumentGroup = {
2
3
  displayName: "Guitar",
3
4
  description: "Guitar fretboards with common standard, alternate, and open tunings.",
4
5
  instrumentKeys: ["guitar"],
5
6
  };
7
+ /** Curated group for bass guitar tunings and fretboard use cases. */
6
8
  export const bassInstrumentGroup = {
7
9
  displayName: "Bass",
8
10
  description: "Bass guitar fretboards with common standard and extended-range tunings.",
9
11
  instrumentKeys: ["bassGuitar"],
10
12
  };
13
+ /** Curated group for mandolin, ukulele, and similar fretted strings. */
11
14
  export const folkAndFrettedStringsInstrumentGroup = {
12
15
  displayName: "Folk & Fretted Strings",
13
16
  description: "Mandolin, ukulele, and related fretted string instruments often used in folk, traditional, and popular styles.",
14
17
  instrumentKeys: ["mandolin", "ukulele"],
15
18
  };
19
+ /** Curated group for violin, viola, cello, and double bass. */
16
20
  export const orchestralStringsInstrumentGroup = {
17
21
  displayName: "Orchestral Strings",
18
22
  description: "Violin, viola, cello, and double bass as the standard bowed string section of the orchestra.",
@@ -24,5 +28,7 @@ const _stringInstrumentGroups = {
24
28
  folkAndFrettedStrings: folkAndFrettedStringsInstrumentGroup,
25
29
  orchestralStrings: orchestralStringsInstrumentGroup,
26
30
  };
31
+ /** Built-in string instrument groups for navigation and filtering. */
27
32
  export const stringInstrumentGroups = _stringInstrumentGroups;
33
+ /** Ordered keys for the built-in string instrument groups. */
28
34
  export const stringInstrumentGroupKeys = Object.keys(_stringInstrumentGroups);
@@ -21,10 +21,15 @@ declare const _stringInstrumentTunings: {
21
21
  readonly guitarOpenDMinor: StringInstrumentTuning;
22
22
  readonly guitarJacobCollierTuning: StringInstrumentTuning;
23
23
  };
24
+ /** A key for one of the built-in string instrument tunings. */
24
25
  export type StringInstrumentTuningKey = keyof typeof _stringInstrumentTunings;
26
+ /** Dictionary of all built-in string instrument tunings keyed by tuning id. */
25
27
  export type StringInstrumentTunings = Record<StringInstrumentTuningKey, StringInstrumentTuning>;
28
+ /** All built-in string instrument tunings from every supported instrument family. */
26
29
  export declare const stringInstrumentTunings: StringInstrumentTunings;
30
+ /** Ordered keys for all built-in string instrument tunings. */
27
31
  export declare const stringInstrumentTuningKeys: readonly StringInstrumentTuningKey[];
32
+ /** Metadata for a supported string instrument. */
28
33
  export interface StringInstrument {
29
34
  /** The canonical instrument label to show in app UI. */
30
35
  primaryName: string;
@@ -35,10 +40,15 @@ export interface StringInstrument {
35
40
  /** The tuning key to select when an app needs an initial/default tuning. */
36
41
  defaultTuning: StringInstrumentTuningKey;
37
42
  }
43
+ /** Dictionary of supported string instruments keyed by instrument id. */
38
44
  export type StringInstruments = Readonly<Record<StringInstrumentKey, StringInstrument>>;
45
+ /** Metadata for all supported string instruments. */
39
46
  export declare const stringInstruments: StringInstruments;
47
+ /** Ordered keys for all supported string instruments. */
40
48
  export declare const stringInstrumentKeys: readonly StringInstrumentKey[];
49
+ /** Tuning keys grouped by supported string instrument. */
41
50
  export type StringInstrumentTuningKeysByInstrument = Readonly<Record<StringInstrumentKey, readonly StringInstrumentTuningKey[]>>;
51
+ /** Built-in tuning keys grouped by supported string instrument. */
42
52
  export declare const stringInstrumentTuningKeysByInstrument: StringInstrumentTuningKeysByInstrument;
43
53
  export {};
44
54
  //# sourceMappingURL=string-instrument-tunings.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"string-instrument-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/string-instrument-tunings.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACV,sBAAsB,EACtB,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,QAAA,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;CAKpB,CAAC;AAEX,MAAM,MAAM,yBAAyB,GAAG,MAAM,OAAO,wBAAwB,CAAC;AAE9E,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAC1C,yBAAyB,EACzB,sBAAsB,CACvB,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,uBACZ,CAAC;AAE3B,eAAO,MAAM,0BAA0B,EAAE,SAAS,yBAAyB,EAGhC,CAAC;AAE5C,MAAM,WAAW,gBAAgB;IAC/B,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,2DAA2D;IAC3D,MAAM,EAAE,sBAAsB,CAAC;IAC/B,4EAA4E;IAC5E,aAAa,EAAE,yBAAyB,CAAC;CAC1C;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CACtC,MAAM,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAC9C,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,iBA4C/B,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,SAAS,mBAAmB,EAE5B,CAAC;AAEpC,MAAM,MAAM,sCAAsC,GAAG,QAAQ,CAC3D,MAAM,CAAC,mBAAmB,EAAE,SAAS,yBAAyB,EAAE,CAAC,CAClE,CAAC;AAEF,eAAO,MAAM,sCAAsC,EACjD,sCAKC,CAAC"}
1
+ {"version":3,"file":"string-instrument-tunings.d.ts","sourceRoot":"","sources":["../../../../src/src/data/tunings/string-instrument-tunings.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACV,sBAAsB,EACtB,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,QAAA,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;CAKpB,CAAC;AAEX,+DAA+D;AAC/D,MAAM,MAAM,yBAAyB,GAAG,MAAM,OAAO,wBAAwB,CAAC;AAE9E,+EAA+E;AAC/E,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAC1C,yBAAyB,EACzB,sBAAsB,CACvB,CAAC;AAEF,qFAAqF;AACrF,eAAO,MAAM,uBAAuB,EAAE,uBACZ,CAAC;AAE3B,+DAA+D;AAC/D,eAAO,MAAM,0BAA0B,EAAE,SAAS,yBAAyB,EAGhC,CAAC;AAE5C,kDAAkD;AAClD,MAAM,WAAW,gBAAgB;IAC/B,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,2DAA2D;IAC3D,MAAM,EAAE,sBAAsB,CAAC;IAC/B,4EAA4E;IAC5E,aAAa,EAAE,yBAAyB,CAAC;CAC1C;AAED,yEAAyE;AACzE,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CACtC,MAAM,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAC9C,CAAC;AAEF,qDAAqD;AACrD,eAAO,MAAM,iBAAiB,EAAE,iBA4C/B,CAAC;AAEF,yDAAyD;AACzD,eAAO,MAAM,oBAAoB,EAAE,SAAS,mBAAmB,EAE5B,CAAC;AAEpC,0DAA0D;AAC1D,MAAM,MAAM,sCAAsC,GAAG,QAAQ,CAC3D,MAAM,CAAC,mBAAmB,EAAE,SAAS,yBAAyB,EAAE,CAAC,CAClE,CAAC;AAEF,mEAAmE;AACnE,eAAO,MAAM,sCAAsC,EACjD,sCAKC,CAAC"}
@@ -8,8 +8,11 @@ const _stringInstrumentTunings = {
8
8
  ...folkFrettedStringTunings,
9
9
  ...orchestralStringTunings,
10
10
  };
11
+ /** All built-in string instrument tunings from every supported instrument family. */
11
12
  export const stringInstrumentTunings = _stringInstrumentTunings;
13
+ /** Ordered keys for all built-in string instrument tunings. */
12
14
  export const stringInstrumentTuningKeys = Object.keys(_stringInstrumentTunings);
15
+ /** Metadata for all supported string instruments. */
13
16
  export const stringInstruments = {
14
17
  guitar: {
15
18
  primaryName: "Guitar",
@@ -55,7 +58,9 @@ export const stringInstruments = {
55
58
  defaultTuning: "doubleBassStandardEadg",
56
59
  },
57
60
  };
61
+ /** Ordered keys for all supported string instruments. */
58
62
  export const stringInstrumentKeys = Object.keys(stringInstruments);
63
+ /** Built-in tuning keys grouped by supported string instrument. */
59
64
  export const stringInstrumentTuningKeysByInstrument = {
60
65
  guitar: guitarTuningKeys,
61
66
  ...bassGuitarTuningKeysByInstrument,
package/esm/src/mod.d.ts CHANGED
@@ -1,50 +1,3 @@
1
- /**
2
- * A comprehensive library of music theory data, including notes, dyads, scales, chord pitch collections, and chord progressions.
3
- *
4
- * This package provides a collection of datasets and utility functions
5
- * to work with fundamental concepts of music theory. It's designed to be
6
- * a foundational block for music-related applications, educational tools,
7
- * and creative coding projects.
8
- *
9
- * @module
10
- * @example
11
- * ```ts
12
- * import * as music_theory_data from "jsr:@musodojo/music-theory-data";
13
- *
14
- * // Get the notes of A Harmonic Minor
15
- * const notes1 = music_theory_data.getNoteNamesForRootAndNoteCollectionKey(
16
- * "A",
17
- * "harmonicMinor",
18
- * );
19
- * console.log(notes1);
20
- * // ["A", "B", "C", "D", "E", "F", "G♯", "A"]
21
- *
22
- * // Automatically knows whether to use flats or sharps
23
- * const notes2 = music_theory_data.getNoteNamesForRootAndNoteCollectionKey(
24
- * "F",
25
- * "ionian",
26
- * );
27
- * console.log(notes2);
28
- * // ["F", "G", "A", "B♭", "C", "D", "E", "F"];
29
- *
30
- * // Get the full data structure for the Ionian mode (Major Scale)
31
- * const ionian = music_theory_data.noteCollections.ionian;
32
- *
33
- * console.log(ionian.primaryName);
34
- * // "Major"
35
- *
36
- * console.log(ionian.intervals);
37
- * // ["1", "2", "3", "4", "5", "6", "7", "8"]
38
- *
39
- * // Log an array of all available Note Collection Keys
40
- * console.log(Object.keys(music_theory_data.noteCollections));
41
- * // ["ionian", "dorian", "phrygian", ...]
42
- *
43
- * // Log an array of all available Grouped Note Collections Keys
44
- * console.log(Object.keys(music_theory_data.groupedNoteCollections));
45
- * // ["diatonicModes", "pentatonicVariants", ...]
46
- * ```
47
- */
48
1
  export * from "./data/mod.js";
49
2
  export type * from "./types/mod";
50
3
  export * from "./utils/mod.js";
@@ -1 +1 @@
1
- {"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/src/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,cAAc,eAAe,CAAC;AAC9B,mBAAmB,aAAa,CAAC;AACjC,cAAc,gBAAgB,CAAC"}
1
+ {"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,mBAAmB,aAAa,CAAC;AACjC,cAAc,gBAAgB,CAAC"}
package/esm/src/mod.js CHANGED
@@ -1,49 +1,2 @@
1
- /**
2
- * A comprehensive library of music theory data, including notes, dyads, scales, chord pitch collections, and chord progressions.
3
- *
4
- * This package provides a collection of datasets and utility functions
5
- * to work with fundamental concepts of music theory. It's designed to be
6
- * a foundational block for music-related applications, educational tools,
7
- * and creative coding projects.
8
- *
9
- * @module
10
- * @example
11
- * ```ts
12
- * import * as music_theory_data from "jsr:@musodojo/music-theory-data";
13
- *
14
- * // Get the notes of A Harmonic Minor
15
- * const notes1 = music_theory_data.getNoteNamesForRootAndNoteCollectionKey(
16
- * "A",
17
- * "harmonicMinor",
18
- * );
19
- * console.log(notes1);
20
- * // ["A", "B", "C", "D", "E", "F", "G♯", "A"]
21
- *
22
- * // Automatically knows whether to use flats or sharps
23
- * const notes2 = music_theory_data.getNoteNamesForRootAndNoteCollectionKey(
24
- * "F",
25
- * "ionian",
26
- * );
27
- * console.log(notes2);
28
- * // ["F", "G", "A", "B♭", "C", "D", "E", "F"];
29
- *
30
- * // Get the full data structure for the Ionian mode (Major Scale)
31
- * const ionian = music_theory_data.noteCollections.ionian;
32
- *
33
- * console.log(ionian.primaryName);
34
- * // "Major"
35
- *
36
- * console.log(ionian.intervals);
37
- * // ["1", "2", "3", "4", "5", "6", "7", "8"]
38
- *
39
- * // Log an array of all available Note Collection Keys
40
- * console.log(Object.keys(music_theory_data.noteCollections));
41
- * // ["ionian", "dorian", "phrygian", ...]
42
- *
43
- * // Log an array of all available Grouped Note Collections Keys
44
- * console.log(Object.keys(music_theory_data.groupedNoteCollections));
45
- * // ["diatonicModes", "pentatonicVariants", ...]
46
- * ```
47
- */
48
1
  export * from "./data/mod.js";
49
2
  export * from "./utils/mod.js";