@musodojo/music-theory-data 31.0.0 → 32.0.0

package/script/src/data/tunings/guitar-tunings.js

@@ -105,7 +105,9 @@ const _guitarTunings = {
     guitarOpenDMinor,
     guitarJacobCollierTuning,
 };
+/** Built-in guitar tunings. */
 exports.guitarTunings = _guitarTunings;
+/** Ordered keys for the built-in guitar tunings. */
 exports.guitarTuningKeys = Object.keys(_guitarTunings);
 const standardGuitarTuningGroup = {
     displayName: "Standard",
@@ -139,4 +141,5 @@ const _guitarTuningGroups = {
     modal: modalGuitarTuningGroup,
     open: openGuitarTuningGroup,
 };
+/** Built-in guitar tuning groups for standard, drop, modal, and open tunings. */
 exports.guitarTuningGroups = _guitarTuningGroups;

package/script/src/data/tunings/orchestral-string-tunings.d.ts

@@ -1,5 +1,6 @@
 import type { StringInstrumentKey, StringInstrumentTuning } from "../../types/string-instruments";
 export { orchestralStringsInstrumentGroup } from "./string-instrument-groups.js";
+/** Instrument keys covered by the orchestral string tuning registry. */
 export type OrchestralStringInstrumentKey = Extract<StringInstrumentKey, "violin" | "viola" | "cello" | "doubleBass">;
 declare const _orchestralStringTunings: {
     readonly violinStandardGdae: StringInstrumentTuning;
@@ -7,9 +8,14 @@ declare const _orchestralStringTunings: {
     readonly celloStandardCgda: StringInstrumentTuning;
     readonly doubleBassStandardEadg: StringInstrumentTuning;
 };
+/** A key for one of the built-in orchestral string tunings. */
 export type OrchestralStringTuningKey = keyof typeof _orchestralStringTunings;
+/** Dictionary of built-in orchestral string tunings keyed by tuning id. */
 export type OrchestralStringTunings = Record<OrchestralStringTuningKey, StringInstrumentTuning>;
+/** Built-in violin, viola, cello, and double bass tunings. */
 export declare const orchestralStringTunings: OrchestralStringTunings;
+/** Orchestral string tuning keys grouped by instrument. */
 export type OrchestralStringTuningKeysByInstrument = Readonly<Record<OrchestralStringInstrumentKey, readonly OrchestralStringTuningKey[]>>;
+/** Built-in orchestral string tuning keys grouped by instrument. */
 export declare const orchestralStringTuningKeysByInstrument: OrchestralStringTuningKeysByInstrument;
 //# sourceMappingURL=orchestral-string-tunings.d.ts.map

package/script/src/data/tunings/orchestral-string-tunings.d.ts.map

@@ -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"}
+{"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"}

package/script/src/data/tunings/orchestral-string-tunings.js

@@ -37,7 +37,9 @@ const _orchestralStringTunings = {
     celloStandardCgda,
     doubleBassStandardEadg,
 };
+/** Built-in violin, viola, cello, and double bass tunings. */
 exports.orchestralStringTunings = _orchestralStringTunings;
+/** Built-in orchestral string tuning keys grouped by instrument. */
 exports.orchestralStringTuningKeysByInstrument = {
     violin: ["violinStandardGdae"],
     viola: ["violaStandardCgda"],

package/script/src/data/tunings/string-instrument-groups.d.ts

@@ -1,7 +1,11 @@
 import type { StringInstrumentGroup } from "../../types/string-instruments";
+/** Curated group for guitar tunings and fretboard use cases. */
 export declare const guitarInstrumentGroup: StringInstrumentGroup;
+/** Curated group for bass guitar tunings and fretboard use cases. */
 export declare const bassInstrumentGroup: StringInstrumentGroup;
+/** Curated group for mandolin, ukulele, and similar fretted strings. */
 export declare const folkAndFrettedStringsInstrumentGroup: StringInstrumentGroup;
+/** Curated group for violin, viola, cello, and double bass. */
 export declare const orchestralStringsInstrumentGroup: StringInstrumentGroup;
 declare const _stringInstrumentGroups: {
     readonly guitar: StringInstrumentGroup;
@@ -9,9 +13,13 @@ declare const _stringInstrumentGroups: {
     readonly folkAndFrettedStrings: StringInstrumentGroup;
     readonly orchestralStrings: StringInstrumentGroup;
 };
+/** A key for one of the built-in string instrument groups. */
 export type StringInstrumentGroupKey = keyof typeof _stringInstrumentGroups;
+/** Dictionary of built-in string instrument groups keyed by group id. */
 export type StringInstrumentGroups = Record<StringInstrumentGroupKey, StringInstrumentGroup>;
+/** Built-in string instrument groups for navigation and filtering. */
 export declare const stringInstrumentGroups: StringInstrumentGroups;
+/** Ordered keys for the built-in string instrument groups. */
 export declare const stringInstrumentGroupKeys: readonly StringInstrumentGroupKey[];
 export {};
 //# sourceMappingURL=string-instrument-groups.d.ts.map

package/script/src/data/tunings/string-instrument-groups.d.ts.map

@@ -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"}
+{"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"}

package/script/src/data/tunings/string-instrument-groups.js

@@ -1,21 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stringInstrumentGroupKeys = exports.stringInstrumentGroups = exports.orchestralStringsInstrumentGroup = exports.folkAndFrettedStringsInstrumentGroup = exports.bassInstrumentGroup = exports.guitarInstrumentGroup = void 0;
+/** Curated group for guitar tunings and fretboard use cases. */
 exports.guitarInstrumentGroup = {
     displayName: "Guitar",
     description: "Guitar fretboards with common standard, alternate, and open tunings.",
     instrumentKeys: ["guitar"],
 };
+/** Curated group for bass guitar tunings and fretboard use cases. */
 exports.bassInstrumentGroup = {
     displayName: "Bass",
     description: "Bass guitar fretboards with common standard and extended-range tunings.",
     instrumentKeys: ["bassGuitar"],
 };
+/** Curated group for mandolin, ukulele, and similar fretted strings. */
 exports.folkAndFrettedStringsInstrumentGroup = {
     displayName: "Folk & Fretted Strings",
     description: "Mandolin, ukulele, and related fretted string instruments often used in folk, traditional, and popular styles.",
     instrumentKeys: ["mandolin", "ukulele"],
 };
+/** Curated group for violin, viola, cello, and double bass. */
 exports.orchestralStringsInstrumentGroup = {
     displayName: "Orchestral Strings",
     description: "Violin, viola, cello, and double bass as the standard bowed string section of the orchestra.",
@@ -27,5 +31,7 @@ const _stringInstrumentGroups = {
     folkAndFrettedStrings: exports.folkAndFrettedStringsInstrumentGroup,
     orchestralStrings: exports.orchestralStringsInstrumentGroup,
 };
+/** Built-in string instrument groups for navigation and filtering. */
 exports.stringInstrumentGroups = _stringInstrumentGroups;
+/** Ordered keys for the built-in string instrument groups. */
 exports.stringInstrumentGroupKeys = Object.keys(_stringInstrumentGroups);

package/script/src/data/tunings/string-instrument-tunings.d.ts

@@ -21,10 +21,15 @@ declare const _stringInstrumentTunings: {
     readonly guitarOpenDMinor: StringInstrumentTuning;
     readonly guitarJacobCollierTuning: StringInstrumentTuning;
 };
+/** A key for one of the built-in string instrument tunings. */
 export type StringInstrumentTuningKey = keyof typeof _stringInstrumentTunings;
+/** Dictionary of all built-in string instrument tunings keyed by tuning id. */
 export type StringInstrumentTunings = Record<StringInstrumentTuningKey, StringInstrumentTuning>;
+/** All built-in string instrument tunings from every supported instrument family. */
 export declare const stringInstrumentTunings: StringInstrumentTunings;
+/** Ordered keys for all built-in string instrument tunings. */
 export declare const stringInstrumentTuningKeys: readonly StringInstrumentTuningKey[];
+/** Metadata for a supported string instrument. */
 export interface StringInstrument {
     /** The canonical instrument label to show in app UI. */
     primaryName: string;
@@ -35,10 +40,15 @@ export interface StringInstrument {
     /** The tuning key to select when an app needs an initial/default tuning. */
     defaultTuning: StringInstrumentTuningKey;
 }
+/** Dictionary of supported string instruments keyed by instrument id. */
 export type StringInstruments = Readonly<Record<StringInstrumentKey, StringInstrument>>;
+/** Metadata for all supported string instruments. */
 export declare const stringInstruments: StringInstruments;
+/** Ordered keys for all supported string instruments. */
 export declare const stringInstrumentKeys: readonly StringInstrumentKey[];
+/** Tuning keys grouped by supported string instrument. */
 export type StringInstrumentTuningKeysByInstrument = Readonly<Record<StringInstrumentKey, readonly StringInstrumentTuningKey[]>>;
+/** Built-in tuning keys grouped by supported string instrument. */
 export declare const stringInstrumentTuningKeysByInstrument: StringInstrumentTuningKeysByInstrument;
 export {};
 //# sourceMappingURL=string-instrument-tunings.d.ts.map

package/script/src/data/tunings/string-instrument-tunings.d.ts.map

@@ -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"}
+{"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"}

package/script/src/data/tunings/string-instrument-tunings.js

@@ -11,8 +11,11 @@ const _stringInstrumentTunings = {
     ...folk_fretted_string_tunings_js_1.folkFrettedStringTunings,
     ...orchestral_string_tunings_js_1.orchestralStringTunings,
 };
+/** All built-in string instrument tunings from every supported instrument family. */
 exports.stringInstrumentTunings = _stringInstrumentTunings;
+/** Ordered keys for all built-in string instrument tunings. */
 exports.stringInstrumentTuningKeys = Object.keys(_stringInstrumentTunings);
+/** Metadata for all supported string instruments. */
 exports.stringInstruments = {
     guitar: {
         primaryName: "Guitar",
@@ -58,7 +61,9 @@ exports.stringInstruments = {
         defaultTuning: "doubleBassStandardEadg",
     },
 };
+/** Ordered keys for all supported string instruments. */
 exports.stringInstrumentKeys = Object.keys(exports.stringInstruments);
+/** Built-in tuning keys grouped by supported string instrument. */
 exports.stringInstrumentTuningKeysByInstrument = {
     guitar: guitar_tunings_js_1.guitarTuningKeys,
     ...bass_guitar_tunings_js_1.bassGuitarTuningKeysByInstrument,

package/script/src/mod.d.ts

@@ -1,50 +1,3 @@
-/**
- * A comprehensive library of music theory data, including notes, dyads, scales, chord pitch collections, and chord progressions.
- *
- * This package provides a collection of datasets and utility functions
- * to work with fundamental concepts of music theory. It's designed to be
- * a foundational block for music-related applications, educational tools,
- * and creative coding projects.
- *
- * @module
- * @example
- * ```ts
- * import * as music_theory_data from "jsr:@musodojo/music-theory-data";
- *
- * // Get the notes of A Harmonic Minor
- * const notes1 = music_theory_data.getNoteNamesForRootAndNoteCollectionKey(
- *   "A",
- *   "harmonicMinor",
- * );
- * console.log(notes1);
- * // ["A", "B", "C", "D", "E", "F", "G♯", "A"]
- *
- * // Automatically knows whether to use flats or sharps
- * const notes2 = music_theory_data.getNoteNamesForRootAndNoteCollectionKey(
- *   "F",
- *   "ionian",
- * );
- * console.log(notes2);
- * //  ["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;
- *
- * console.log(ionian.primaryName);
- * // "Major"
- *
- * console.log(ionian.intervals);
- * // ["1", "2", "3", "4", "5", "6", "7", "8"]
- *
- * // Log an array of all available Note Collection Keys
- * console.log(Object.keys(music_theory_data.noteCollections));
- * // ["ionian", "dorian", "phrygian", ...]
- *
- * // Log an array of all available Grouped Note Collections Keys
- * console.log(Object.keys(music_theory_data.groupedNoteCollections));
- * // ["diatonicModes", "pentatonicVariants", ...]
- * ```
- */
 export * from "./data/mod.js";
 export type * from "./types/mod";
 export * from "./utils/mod.js";

package/script/src/mod.d.ts.map

@@ -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"}
+{"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/script/src/mod.js

@@ -14,52 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * A comprehensive library of music theory data, including notes, dyads, scales, chord pitch collections, and chord progressions.
- *
- * This package provides a collection of datasets and utility functions
- * to work with fundamental concepts of music theory. It's designed to be
- * a foundational block for music-related applications, educational tools,
- * and creative coding projects.
- *
- * @module
- * @example
- * ```ts
- * import * as music_theory_data from "jsr:@musodojo/music-theory-data";
- *
- * // Get the notes of A Harmonic Minor
- * const notes1 = music_theory_data.getNoteNamesForRootAndNoteCollectionKey(
- *   "A",
- *   "harmonicMinor",
- * );
- * console.log(notes1);
- * // ["A", "B", "C", "D", "E", "F", "G♯", "A"]
- *
- * // Automatically knows whether to use flats or sharps
- * const notes2 = music_theory_data.getNoteNamesForRootAndNoteCollectionKey(
- *   "F",
- *   "ionian",
- * );
- * console.log(notes2);
- * //  ["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;
- *
- * console.log(ionian.primaryName);
- * // "Major"
- *
- * console.log(ionian.intervals);
- * // ["1", "2", "3", "4", "5", "6", "7", "8"]
- *
- * // Log an array of all available Note Collection Keys
- * console.log(Object.keys(music_theory_data.noteCollections));
- * // ["ionian", "dorian", "phrygian", ...]
- *
- * // Log an array of all available Grouped Note Collections Keys
- * console.log(Object.keys(music_theory_data.groupedNoteCollections));
- * // ["diatonicModes", "pentatonicVariants", ...]
- * ```
- */
 __exportStar(require("./data/mod.js"), exports);
 __exportStar(require("./utils/mod.js"), exports);

package/script/src/utils/chord-progressions.d.ts

@@ -2,15 +2,21 @@ import { type ChordProgressionKey } from "../data/chord-progressions/mod.js";
 import type { ChordProgression } from "../types/chord-progressions";
 import type { RootNote } from "../data/labels/note-labels.js";
 import type { NoteCollectionKey } from "../data/note-collections/mod.js";
+/** A resolved chord in a progression, including its root and note-collection key. */
 export interface ChordProgressionChordReference {
     readonly rootNote: RootNote;
     readonly chordName: string;
     readonly noteCollectionKey: NoteCollectionKey;
 }
+/** Returns whether a string is one of the built-in chord progression keys. */
 export declare function isValidChordProgressionKey(key: string): key is ChordProgressionKey;
+/** Returns the spelled chord names for a progression in the requested root. */
 export declare function getChordProgressionChordNames(rootNote: RootNote, progressionOrKey: ChordProgression | ChordProgressionKey): string[];
+/** Returns the roman symbols authored for a chord progression. */
 export declare function getChordProgressionRomanSymbols(progressionOrKey: ChordProgression | ChordProgressionKey): string[];
+/** Returns all built-in chord progression keys with the requested total bar count. */
 export declare function getChordProgressionKeysForTotalBars(totalBars: number): ChordProgressionKey[];
+/** Returns each distinct chord name in a progression, preserving first-seen order. */
 export declare function getChordProgressionUniqueChordNames(rootNote: RootNote, progressionOrKey: ChordProgression | ChordProgressionKey): string[];
 /**
  * Returns one chord reference for each authored chord entry in
@@ -39,5 +45,6 @@ export declare function getChordProgressionChordReferencesByBar(rootNote: RootNo
  * appears twice and split bars preserve their left-to-right order.
  */
 export declare function getChordProgressionSongChordReferences(rootNote: RootNote, progressionOrKey: ChordProgression | ChordProgressionKey): ChordProgressionChordReference[];
+/** Returns the sum of authored chord durations in bars for a progression. */
 export declare function getChordProgressionTotalDurationInBars(progressionOrKey: ChordProgression | ChordProgressionKey): number;
 //# sourceMappingURL=chord-progressions.d.ts.map

package/script/src/utils/chord-progressions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chord-progressions.d.ts","sourceRoot":"","sources":["../../../src/src/utils/chord-progressions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,mBAAmB,EAEzB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,KAAK,EACV,gBAAgB,EAEjB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAMzE,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;CAC/C;AASD,wBAAgB,0BAA0B,CACxC,GAAG,EAAE,MAAM,GACV,GAAG,IAAI,mBAAmB,CAE5B;AA2CD,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,MAAM,EAAE,CAYV;AAED,wBAAgB,+BAA+B,CAC7C,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,MAAM,EAAE,CAKV;AAED,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,MAAM,GAChB,mBAAmB,EAAE,CAKvB;AAED,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,MAAM,EAAE,CAIV;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,8BAA8B,EAAE,CAKlC;AAED;;;GAGG;AACH,wBAAgB,wCAAwC,CACtD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,8BAA8B,EAAE,CAkBlC;AAED;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACrD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,8BAA8B,EAAE,EAAE,CAiDpC;AAED;;;;;GAKG;AACH,wBAAgB,sCAAsC,CACpD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,8BAA8B,EAAE,CAKlC;AAED,wBAAgB,sCAAsC,CACpD,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,MAAM,CAQR"}
+{"version":3,"file":"chord-progressions.d.ts","sourceRoot":"","sources":["../../../src/src/utils/chord-progressions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,mBAAmB,EAEzB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,KAAK,EACV,gBAAgB,EAEjB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAMzE,qFAAqF;AACrF,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;CAC/C;AASD,8EAA8E;AAC9E,wBAAgB,0BAA0B,CACxC,GAAG,EAAE,MAAM,GACV,GAAG,IAAI,mBAAmB,CAE5B;AA2CD,+EAA+E;AAC/E,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,MAAM,EAAE,CAYV;AAED,kEAAkE;AAClE,wBAAgB,+BAA+B,CAC7C,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,MAAM,EAAE,CAKV;AAED,sFAAsF;AACtF,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,MAAM,GAChB,mBAAmB,EAAE,CAKvB;AAED,sFAAsF;AACtF,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,MAAM,EAAE,CAIV;AAED;;;;;;GAMG;AACH,wBAAgB,wCAAwC,CACtD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,8BAA8B,EAAE,CAKlC;AAED;;;GAGG;AACH,wBAAgB,wCAAwC,CACtD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,8BAA8B,EAAE,CAkBlC;AAED;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACrD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,8BAA8B,EAAE,EAAE,CAiDpC;AAED;;;;;GAKG;AACH,wBAAgB,sCAAsC,CACpD,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,8BAA8B,EAAE,CAKlC;AAED,6EAA6E;AAC7E,wBAAgB,sCAAsC,CACpD,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,GACvD,MAAM,CAQR"}

package/script/src/utils/chord-progressions.js

@@ -14,6 +14,7 @@ const mod_js_1 = require("../data/chord-progressions/mod.js");
 const mod_js_2 = require("../data/chords/mod.js");
 const note_names_js_1 = require("./note-names.js");
 const BAR_DURATION_EPSILON = 0.000000001;
+/** Returns whether a string is one of the built-in chord progression keys. */
 function isValidChordProgressionKey(key) {
     return Object.prototype.hasOwnProperty.call(mod_js_1.chordProgressions, key);
 }
@@ -44,6 +45,7 @@ function getResolvedChordProgressionChordReferences(rootNote, progressionOrKey)
             }];
     });
 }
+/** Returns the spelled chord names for a progression in the requested root. */
 function getChordProgressionChordNames(rootNote, progressionOrKey) {
     const progression = resolveProgression(progressionOrKey);
     if (!progression)
@@ -51,16 +53,19 @@ function getChordProgressionChordNames(rootNote, progressionOrKey) {
     const noteNames = (0, note_names_js_1.getNoteNamesForRootAndIntervals)(rootNote, progression.chords.map((chord) => chord.degree));
     return progression.chords.map((chord, index) => noteNames[index] + chord.quality);
 }
+/** Returns the roman symbols authored for a chord progression. */
 function getChordProgressionRomanSymbols(progressionOrKey) {
     const progression = resolveProgression(progressionOrKey);
     if (!progression)
         return [];
     return progression.chords.map((chord) => chord.romanSymbol);
 }
+/** Returns all built-in chord progression keys with the requested total bar count. */
 function getChordProgressionKeysForTotalBars(totalBars) {
     return mod_js_1.chordProgressionBarGroups.find((group) => group.totalBars === totalBars)
         ?.progressionKeys.slice() ?? [];
 }
+/** Returns each distinct chord name in a progression, preserving first-seen order. */
 function getChordProgressionUniqueChordNames(rootNote, progressionOrKey) {
     return Array.from(new Set(getChordProgressionChordNames(rootNote, progressionOrKey)));
 }
@@ -135,6 +140,7 @@ function getChordProgressionChordReferencesByBar(rootNote, progressionOrKey) {
 function getChordProgressionSongChordReferences(rootNote, progressionOrKey) {
     return getChordProgressionChordReferencesByBar(rootNote, progressionOrKey).flat();
 }
+/** Returns the sum of authored chord durations in bars for a progression. */
 function getChordProgressionTotalDurationInBars(progressionOrKey) {
     const progression = resolveProgression(progressionOrKey);
     if (!progression)