@tspro/web-music-score 3.2.0 → 4.0.0

package/dist/tempo-BAYoZ_Li.d.mts

@@ -0,0 +1,187 @@
+import { N as Note, A as Accidental } from './note-BFa43I86.mjs';
+
+declare enum Mode {
+    Ionian = 1,
+    Dorian = 2,
+    Phrygian = 3,
+    Lydian = 4,
+    Mixolydian = 5,
+    Aeolian = 6,
+    Locrian = 7
+}
+declare enum AccidentalType {
+    Natural = 0,
+    Flats = 1,
+    Sharps = 2
+}
+declare function getDefaultKeySignature(): KeySignature;
+declare class KeySignature {
+    readonly tonic: string;
+    readonly mode: Mode;
+    private static readonly OrderOfSharps;
+    private static readonly OrderOfFlats;
+    private readonly naturalScaleNotes;
+    private readonly accidentalByDiatonicClass;
+    private readonly orderedAccidentedNotes;
+    /**
+     * @param tonic - Tonic/root note.
+     * @param mode - Mode: Ionian/Major = 1, Dorian = 2, ..., Locrian = 7
+     */
+    protected constructor(tonic: string, mode: Mode);
+    getAccidentalType(): AccidentalType;
+    getNaturalScaleNotes(): ReadonlyArray<Note>;
+    getAccidental(diatonicId: number): Accidental;
+    getNumAccidentals(): number;
+    getOrderedAccidentalNotes(): ReadonlyArray<Note>;
+    /**
+     *
+     * @param degree - number 1..7 or string e.g "b5" or "#4"
+     * @returns
+     */
+    getNoteByDegree(degree: number | string): Note;
+    static equals(a: KeySignature | null | undefined, b: KeySignature | null | undefined): boolean;
+}
+
+declare enum NoteLength {
+    Whole = "1n",
+    WholeTriplet = "1t",
+    WholeDot = "1.",
+    Whole12Dots = "1..",
+    Whole3Dots = "1...",
+    Whole4Dots = "1....",
+    Whole5Dots = "1.....",
+    Whole6Dots = "1......",
+    Half = "2n",
+    HalfTriplet = "2t",
+    HalfDot = "2.",
+    Half2Dots = "2..",
+    Half3Dots = "2...",
+    Half4Dots = "2....",
+    Half5Dots = "2.....",
+    Quarter = "4n",
+    QuarterTriplet = "4t",
+    QuarterDot = "4.",
+    Quarter2Dots = "4..",
+    Quarter3Dots = "4...",
+    Quarter4Dots = "4....",
+    Eighth = "8n",
+    EighthTriplet = "8t",
+    EighthDot = "8.",
+    Eighth2Dots = "8..",
+    Eighth3Dots = "8...",
+    Sixteenth = "16n",
+    SixteenthTriplet = "16t",
+    SixteenthDot = "16.",
+    Sixteenth2Dots = "16..",
+    ThirtySecond = "32n",
+    ThirtySecondTriplet = "32t",
+    ThirtySecondDot = "32.",
+    SixtyFourth = "64n",
+    SixtyFourthTriplet = "64t"
+}
+type NoteLengthStr = `${NoteLength}`;
+declare function validateNoteLength(noteLength: unknown): NoteLength;
+declare class NoteLengthProps {
+    static LongestNoteSize: number;
+    static ShortestNoteSize: number;
+    readonly noteLength: NoteLength;
+    readonly noteSize: number;
+    readonly ticks: number;
+    readonly flagCount: number;
+    readonly dotCount: number;
+    readonly maxDotCount: number;
+    readonly isTriplet: boolean;
+    readonly hasStem: boolean;
+    readonly isSolid: boolean;
+    private constructor();
+    private static cache;
+    static get(noteLength: NoteLength | NoteLengthStr | string): NoteLengthProps;
+    static create(noteLength: NoteLength | NoteLengthStr | string | number, dotCount?: number): NoteLengthProps;
+    /**
+     * Compare note lengths/sizes. Whole (1) > half (2) > quarter (4), etc.
+     * Ignores possible triplet property of note length.
+     * @param a - NoteLengthProps, NoteLength/Str or noteSize
+     * @param b - NoteLengthProps, NoteLength/Str or noteSize
+     * @returns - -1: a < b, 0: a === b, +1: a > b (note length/size comparisons)
+     */
+    static cmp(a: NoteLengthProps | NoteLength | NoteLengthStr | number, b: NoteLengthProps | NoteLength | NoteLengthStr | number): -1 | 0 | 1;
+    /**
+     * Compare note lengths/sizes for equality.
+     * Ignores possible triplet property of note length.
+     * @param a - NoteLengthProps, NoteLength/Str or noteSize
+     * @param b - NoteLengthProps, NoteLength/Str or noteSize
+     * @returns - true: a === b, false: a !== b (note length/size comparisons)
+     */
+    static equals(a: NoteLengthProps | NoteLength | NoteLengthStr | number, b: NoteLengthProps | NoteLength | NoteLengthStr | number): boolean;
+}
+interface TupletRatio {
+    parts: number;
+    inTimeOf: number;
+}
+declare function validateTupletRatio(tupletRatio: unknown): TupletRatio;
+declare const Tuplet: Record<"Duplet" | "Triplet" | "Quadruplet", TupletRatio>;
+declare class RhythmProps {
+    readonly noteLength: NoteLength;
+    readonly noteSize: number;
+    readonly dotCount: number;
+    readonly tupletRatio?: TupletRatio;
+    readonly ticks: number;
+    readonly flagCount: number;
+    readonly hasStem: boolean;
+    readonly isSolidNoteHead: boolean;
+    private constructor();
+    private static NoteSymbolMap;
+    toString(): string;
+    private static cache;
+    static get(noteLength: NoteLength | NoteLengthStr, dotCount?: number, tupletRatio?: TupletRatio): RhythmProps;
+    /**
+     * Compare duration of rhythm props.
+     * @param a - RhythmProps
+     * @param b - RhythmProps
+     * @returns - -1: a < b, 0: a === b, +1: a > b (duration comparisons)
+     */
+    static cmp(a: RhythmProps, b: RhythmProps): -1 | 0 | 1;
+    /**
+     * Compare duration equality of rhythm props.
+     * @param a - RhythmProps
+     * @param b - RhythmProps
+     * @returns - true: a === b, false: a !== b (duration comparisons)
+     */
+    static equals(a: RhythmProps, b: RhythmProps): boolean;
+}
+
+type TimeSignatureString = "2/4" | "3/4" | "4/4" | "6/8" | "9/8";
+declare class TimeSignature {
+    readonly beatCount: number;
+    readonly beatSize: number;
+    /** Lengths in ticks */
+    readonly beatLength: NoteLength;
+    readonly measureTicks: number;
+    readonly beamGroupCount: number;
+    readonly beamGroupLength: number;
+    /**
+     * @param str - For example "4/4".
+     */
+    constructor(str: TimeSignatureString);
+    /**
+     * @param beatCount - Measure beat count.
+     * @param beatSize - Size value: whole-note=1, half-note=2, quarter-note=4, etc.
+     */
+    constructor(beatCount: number, beatSize: number);
+    is(beatCount: number, beatSize: number): boolean;
+    toString(): string;
+}
+declare function getDefaultTimeSignature(): TimeSignature;
+
+type Tempo = {
+    beatsPerMinute: number;
+    options: {
+        beatLength: NoteLength;
+        dotCount: number;
+    };
+};
+declare function getDefaultTempo(): Readonly<Tempo>;
+declare function getTempoString(tempo: Tempo): string;
+declare function alterTempoSpeed(tempo: Tempo, speed: number): Tempo;
+
+export { AccidentalType as A, KeySignature as K, Mode as M, NoteLength as N, RhythmProps as R, type TimeSignatureString as T, TimeSignature as a, getDefaultTimeSignature as b, type Tempo as c, getDefaultTempo as d, getTempoString as e, alterTempoSpeed as f, getDefaultKeySignature as g, type NoteLengthStr as h, NoteLengthProps as i, type TupletRatio as j, validateTupletRatio as k, Tuplet as l, validateNoteLength as v };

package/dist/tempo-r2sb6Ku2.d.ts

@@ -0,0 +1,187 @@
+import { N as Note, A as Accidental } from './note-CcVdUFqS.js';
+
+declare enum Mode {
+    Ionian = 1,
+    Dorian = 2,
+    Phrygian = 3,
+    Lydian = 4,
+    Mixolydian = 5,
+    Aeolian = 6,
+    Locrian = 7
+}
+declare enum AccidentalType {
+    Natural = 0,
+    Flats = 1,
+    Sharps = 2
+}
+declare function getDefaultKeySignature(): KeySignature;
+declare class KeySignature {
+    readonly tonic: string;
+    readonly mode: Mode;
+    private static readonly OrderOfSharps;
+    private static readonly OrderOfFlats;
+    private readonly naturalScaleNotes;
+    private readonly accidentalByDiatonicClass;
+    private readonly orderedAccidentedNotes;
+    /**
+     * @param tonic - Tonic/root note.
+     * @param mode - Mode: Ionian/Major = 1, Dorian = 2, ..., Locrian = 7
+     */
+    protected constructor(tonic: string, mode: Mode);
+    getAccidentalType(): AccidentalType;
+    getNaturalScaleNotes(): ReadonlyArray<Note>;
+    getAccidental(diatonicId: number): Accidental;
+    getNumAccidentals(): number;
+    getOrderedAccidentalNotes(): ReadonlyArray<Note>;
+    /**
+     *
+     * @param degree - number 1..7 or string e.g "b5" or "#4"
+     * @returns
+     */
+    getNoteByDegree(degree: number | string): Note;
+    static equals(a: KeySignature | null | undefined, b: KeySignature | null | undefined): boolean;
+}
+
+declare enum NoteLength {
+    Whole = "1n",
+    WholeTriplet = "1t",
+    WholeDot = "1.",
+    Whole12Dots = "1..",
+    Whole3Dots = "1...",
+    Whole4Dots = "1....",
+    Whole5Dots = "1.....",
+    Whole6Dots = "1......",
+    Half = "2n",
+    HalfTriplet = "2t",
+    HalfDot = "2.",
+    Half2Dots = "2..",
+    Half3Dots = "2...",
+    Half4Dots = "2....",
+    Half5Dots = "2.....",
+    Quarter = "4n",
+    QuarterTriplet = "4t",
+    QuarterDot = "4.",
+    Quarter2Dots = "4..",
+    Quarter3Dots = "4...",
+    Quarter4Dots = "4....",
+    Eighth = "8n",
+    EighthTriplet = "8t",
+    EighthDot = "8.",
+    Eighth2Dots = "8..",
+    Eighth3Dots = "8...",
+    Sixteenth = "16n",
+    SixteenthTriplet = "16t",
+    SixteenthDot = "16.",
+    Sixteenth2Dots = "16..",
+    ThirtySecond = "32n",
+    ThirtySecondTriplet = "32t",
+    ThirtySecondDot = "32.",
+    SixtyFourth = "64n",
+    SixtyFourthTriplet = "64t"
+}
+type NoteLengthStr = `${NoteLength}`;
+declare function validateNoteLength(noteLength: unknown): NoteLength;
+declare class NoteLengthProps {
+    static LongestNoteSize: number;
+    static ShortestNoteSize: number;
+    readonly noteLength: NoteLength;
+    readonly noteSize: number;
+    readonly ticks: number;
+    readonly flagCount: number;
+    readonly dotCount: number;
+    readonly maxDotCount: number;
+    readonly isTriplet: boolean;
+    readonly hasStem: boolean;
+    readonly isSolid: boolean;
+    private constructor();
+    private static cache;
+    static get(noteLength: NoteLength | NoteLengthStr | string): NoteLengthProps;
+    static create(noteLength: NoteLength | NoteLengthStr | string | number, dotCount?: number): NoteLengthProps;
+    /**
+     * Compare note lengths/sizes. Whole (1) > half (2) > quarter (4), etc.
+     * Ignores possible triplet property of note length.
+     * @param a - NoteLengthProps, NoteLength/Str or noteSize
+     * @param b - NoteLengthProps, NoteLength/Str or noteSize
+     * @returns - -1: a < b, 0: a === b, +1: a > b (note length/size comparisons)
+     */
+    static cmp(a: NoteLengthProps | NoteLength | NoteLengthStr | number, b: NoteLengthProps | NoteLength | NoteLengthStr | number): -1 | 0 | 1;
+    /**
+     * Compare note lengths/sizes for equality.
+     * Ignores possible triplet property of note length.
+     * @param a - NoteLengthProps, NoteLength/Str or noteSize
+     * @param b - NoteLengthProps, NoteLength/Str or noteSize
+     * @returns - true: a === b, false: a !== b (note length/size comparisons)
+     */
+    static equals(a: NoteLengthProps | NoteLength | NoteLengthStr | number, b: NoteLengthProps | NoteLength | NoteLengthStr | number): boolean;
+}
+interface TupletRatio {
+    parts: number;
+    inTimeOf: number;
+}
+declare function validateTupletRatio(tupletRatio: unknown): TupletRatio;
+declare const Tuplet: Record<"Duplet" | "Triplet" | "Quadruplet", TupletRatio>;
+declare class RhythmProps {
+    readonly noteLength: NoteLength;
+    readonly noteSize: number;
+    readonly dotCount: number;
+    readonly tupletRatio?: TupletRatio;
+    readonly ticks: number;
+    readonly flagCount: number;
+    readonly hasStem: boolean;
+    readonly isSolidNoteHead: boolean;
+    private constructor();
+    private static NoteSymbolMap;
+    toString(): string;
+    private static cache;
+    static get(noteLength: NoteLength | NoteLengthStr, dotCount?: number, tupletRatio?: TupletRatio): RhythmProps;
+    /**
+     * Compare duration of rhythm props.
+     * @param a - RhythmProps
+     * @param b - RhythmProps
+     * @returns - -1: a < b, 0: a === b, +1: a > b (duration comparisons)
+     */
+    static cmp(a: RhythmProps, b: RhythmProps): -1 | 0 | 1;
+    /**
+     * Compare duration equality of rhythm props.
+     * @param a - RhythmProps
+     * @param b - RhythmProps
+     * @returns - true: a === b, false: a !== b (duration comparisons)
+     */
+    static equals(a: RhythmProps, b: RhythmProps): boolean;
+}
+
+type TimeSignatureString = "2/4" | "3/4" | "4/4" | "6/8" | "9/8";
+declare class TimeSignature {
+    readonly beatCount: number;
+    readonly beatSize: number;
+    /** Lengths in ticks */
+    readonly beatLength: NoteLength;
+    readonly measureTicks: number;
+    readonly beamGroupCount: number;
+    readonly beamGroupLength: number;
+    /**
+     * @param str - For example "4/4".
+     */
+    constructor(str: TimeSignatureString);
+    /**
+     * @param beatCount - Measure beat count.
+     * @param beatSize - Size value: whole-note=1, half-note=2, quarter-note=4, etc.
+     */
+    constructor(beatCount: number, beatSize: number);
+    is(beatCount: number, beatSize: number): boolean;
+    toString(): string;
+}
+declare function getDefaultTimeSignature(): TimeSignature;
+
+type Tempo = {
+    beatsPerMinute: number;
+    options: {
+        beatLength: NoteLength;
+        dotCount: number;
+    };
+};
+declare function getDefaultTempo(): Readonly<Tempo>;
+declare function getTempoString(tempo: Tempo): string;
+declare function alterTempoSpeed(tempo: Tempo, speed: number): Tempo;
+
+export { AccidentalType as A, KeySignature as K, Mode as M, NoteLength as N, RhythmProps as R, type TimeSignatureString as T, TimeSignature as a, getDefaultTimeSignature as b, type Tempo as c, getDefaultTempo as d, getTempoString as e, alterTempoSpeed as f, getDefaultKeySignature as g, type NoteLengthStr as h, NoteLengthProps as i, type TupletRatio as j, validateTupletRatio as k, Tuplet as l, validateNoteLength as v };

package/dist/theory/index.d.mts

@@ -1,9 +1,9 @@
 import { N as Note } from '../note-BFa43I86.mjs';
 export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-BFa43I86.mjs';
-import { D as Degree } from '../scale-DRR-t4Kr.mjs';
-export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-DRR-t4Kr.mjs';
+import { D as Degree } from '../scale-C2pCNxdE.mjs';
+export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-C2pCNxdE.mjs';
 export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-DggbM2UL.mjs';
-export { A as AccidentalType, K as KeySignature, h as MaxNoteLength, i as MinNoteLength, M as Mode, N as NoteLength, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength } from '../tempo-B4h5Ktob.mjs';
+export { A as AccidentalType, K as KeySignature, M as Mode, N as NoteLength, i as NoteLengthProps, h as NoteLengthStr, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, l as Tuplet, j as TupletRatio, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength, k as validateTupletRatio } from '../tempo-BAYoZ_Li.mjs';
 
 type ChordInfo = {
     name: string;

package/dist/theory/index.d.ts

@@ -1,9 +1,9 @@
-import { N as Note } from '../note-BFa43I86.js';
-export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-BFa43I86.js';
-import { D as Degree } from '../scale-ebJm37q1.js';
-export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-ebJm37q1.js';
-export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-C2Cp71NZ.js';
-export { A as AccidentalType, K as KeySignature, h as MaxNoteLength, i as MinNoteLength, M as Mode, N as NoteLength, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength } from '../tempo-DgqDEsn0.js';
+import { N as Note } from '../note-CcVdUFqS.js';
+export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-CcVdUFqS.js';
+import { D as Degree } from '../scale-CvPbJvfN.js';
+export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-CvPbJvfN.js';
+export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-cNmE-EvH.js';
+export { A as AccidentalType, K as KeySignature, M as Mode, N as NoteLength, i as NoteLengthProps, h as NoteLengthStr, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, l as Tuplet, j as TupletRatio, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength, k as validateTupletRatio } from '../tempo-r2sb6Ku2.js';
 
 type ChordInfo = {
     name: string;