@musodojo/music-theory-data 31.1.0 → 33.0.0

package/script/src/utils/note-collections.d.ts

@@ -1,5 +1,6 @@
 import { type NoteCollectionKey } from "../data/note-collections/mod.js";
-import type { Interval } from "../data/labels/note-labels.js";
+import type { ChromaticIndex } from "../data/chromatic.js";
+import { type Interval } from "../data/labels/note-labels.js";
 import type { CollectionCategory, NoteCollection } from "../types/note-collections";
 /**
  * Checks if a given string is a valid `NoteCollectionKey`.
@@ -7,6 +8,13 @@ import type { CollectionCategory, NoteCollection } from "../types/note-collectio
  * @returns `true` if the key is a valid `NoteCollectionKey`, `false` otherwise.
  */
 export declare function isValidNoteCollectionKey(key: string): key is NoteCollectionKey;
+export interface GetNoteCollectionPitchClassesParams {
+    rootNote: string;
+    noteCollectionKey: NoteCollectionKey | string;
+}
+export declare function getNoteCollectionPitchClasses({ rootNote: rawRootNote, noteCollectionKey, }: GetNoteCollectionPitchClassesParams): ReadonlySet<ChromaticIndex> | undefined;
+export declare const noteCollectionDisplayNames: ReadonlyMap<string, string>;
+export declare function getNoteCollectionDisplayName(noteCollectionKey: NoteCollectionKey | string): string;
 /** Search options for finding a note collection. */
 export interface SearchOptions {
     /** A text string to search against collection names, aliases, and characteristics. */

package/script/src/utils/note-collections.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"note-collections.d.ts","sourceRoot":"","sources":["../../../src/src/utils/note-collections.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,iBAAiB,EAEvB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,KAAK,EACV,kBAAkB,EAClB,cAAc,EACf,MAAM,2BAA2B,CAAC;AAEnC;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,MAAM,GACV,GAAG,IAAI,iBAAiB,CAE1B;AAoDD,oDAAoD;AACpD,MAAM,WAAW,aAAa;IAC5B,sFAAsF;IACtF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,gFAAgF;IAChF,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,oGAAoG;IACpG,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,aAAa,GACrB,cAAc,EAAE,CAmGlB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,aAAa,GACrB,cAAc,GAAG,SAAS,CAE5B"}
+{"version":3,"file":"note-collections.d.ts","sourceRoot":"","sources":["../../../src/src/utils/note-collections.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,iBAAiB,EAEvB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EACL,KAAK,QAAQ,EAEd,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,kBAAkB,EAClB,cAAc,EACf,MAAM,2BAA2B,CAAC;AAInC;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,MAAM,GACV,GAAG,IAAI,iBAAiB,CAE1B;AAED,MAAM,WAAW,mCAAmC;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,iBAAiB,GAAG,MAAM,CAAC;CAC/C;AAED,wBAAgB,6BAA6B,CAAC,EAC5C,QAAQ,EAAE,WAAW,EACrB,iBAAiB,GAClB,EAAE,mCAAmC,GAClC,WAAW,CAAC,cAAc,CAAC,GAC3B,SAAS,CAeZ;AAED,eAAO,MAAM,0BAA0B,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAKlE,CAAC;AAEF,wBAAgB,4BAA4B,CAC1C,iBAAiB,EAAE,iBAAiB,GAAG,MAAM,GAC5C,MAAM,CAER;AAoDD,oDAAoD;AACpD,MAAM,WAAW,aAAa;IAC5B,sFAAsF;IACtF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,gFAAgF;IAChF,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,oGAAoG;IACpG,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,aAAa,GACrB,cAAc,EAAE,CAmGlB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,aAAa,GACrB,cAAc,GAAG,SAAS,CAE5B"}

package/script/src/utils/note-collections.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.noteCollectionDisplayNames = void 0;
 exports.isValidNoteCollectionKey = isValidNoteCollectionKey;
+exports.getNoteCollectionPitchClasses = getNoteCollectionPitchClasses;
+exports.getNoteCollectionDisplayName = getNoteCollectionDisplayName;
 exports.searchNoteCollections = searchNoteCollections;
 exports.findNoteCollection = findNoteCollection;
 const mod_js_1 = require("../data/note-collections/mod.js");
+const note_labels_js_1 = require("../data/labels/note-labels.js");
+const chromatic_js_1 = require("./chromatic.js");
+const note_names_js_1 = require("./note-names.js");
 /**
  * Checks if a given string is a valid `NoteCollectionKey`.
  * @param key The string to check.
@@ -12,6 +18,25 @@ const mod_js_1 = require("../data/note-collections/mod.js");
 function isValidNoteCollectionKey(key) {
     return Object.prototype.hasOwnProperty.call(mod_js_1.noteCollections, key);
 }
+function getNoteCollectionPitchClasses({ rootNote: rawRootNote, noteCollectionKey, }) {
+    const rootNote = (0, note_names_js_1.normalizeRootNoteString)(rawRootNote);
+    if (!rootNote || !isValidNoteCollectionKey(noteCollectionKey)) {
+        return undefined;
+    }
+    const rootInteger = note_labels_js_1.rootNoteToIntegerMap.get(rootNote);
+    if (rootInteger === undefined)
+        return undefined;
+    const collection = mod_js_1.noteCollections[noteCollectionKey];
+    const pitchClasses = collection.integers.map((interval) => (0, chromatic_js_1.normalizeChromaticIndex)(rootInteger + interval));
+    return new Set(pitchClasses);
+}
+exports.noteCollectionDisplayNames = new Map(Object.entries(mod_js_1.noteCollections).map(([collectionKey, collection]) => [
+    collectionKey,
+    collection.primaryName,
+]));
+function getNoteCollectionDisplayName(noteCollectionKey) {
+    return exports.noteCollectionDisplayNames.get(noteCollectionKey) ?? noteCollectionKey;
+}
 const normalizationMap = new Map();
 const aliasSets = {
     "♭": ["b", "flat"],

package/script/tests/solfege.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"solfege.test.d.ts","sourceRoot":"","sources":["../../src/tests/solfege.test.ts"],"names":[],"mappings":""}