@tspro/web-music-score 1.1.0 → 3.0.0

package/dist/tempo-DoJd-UYT.d.ts

@@ -0,0 +1,120 @@
+import { N as Note, A as Accidental } from './note-B5ZtlHc8.js';
+
+/** @public */
+declare enum Mode {
+    Ionian = 1,
+    Dorian = 2,
+    Phrygian = 3,
+    Lydian = 4,
+    Mixolydian = 5,
+    Aeolian = 6,
+    Locrian = 7
+}
+/** @public */
+declare enum AccidentalType {
+    Natural = 0,
+    Flats = 1,
+    Sharps = 2
+}
+/** @public */
+declare function getDefaultKeySignature(): KeySignature;
+/** @public */
+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;
+}
+
+/** @public */
+declare enum NoteLength {
+    Whole = 192,// * 3 because triplets are multiplied by 2 / 3, integer result
+    Half = 96,
+    Quarter = 48,
+    Eighth = 24,
+    Sixteenth = 12,
+    ThirtySecond = 6,
+    SixtyFourth = 3
+}
+/** @public */
+declare const MaxNoteLength = NoteLength.Whole;
+/** @public */
+declare const MinNoteLength = NoteLength.SixtyFourth;
+/** @public */
+declare function validateNoteLength(noteLength: unknown): NoteLength;
+/** @public */
+declare class RhythmProps {
+    readonly noteLength: NoteLength;
+    readonly dotted: boolean;
+    readonly triplet: boolean;
+    readonly ticks: number;
+    readonly flagCount: number;
+    constructor(noteLength: NoteLength, dotted?: boolean, triplet?: boolean);
+    static createFromNoteSize(noteSize: number): RhythmProps;
+    canDot(): boolean;
+    hasStem(): boolean;
+    toString(): string;
+}
+
+/** @public */
+type TimeSignatureString = "2/4" | "3/4" | "4/4" | "6/8" | "9/8";
+/** @public */
+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;
+}
+/** @public */
+declare function getDefaultTimeSignature(): TimeSignature;
+
+/** @public */
+type Tempo = {
+    beatsPerMinute: number;
+    options: {
+        beatLength: NoteLength;
+        dotted: boolean;
+    };
+};
+/** @public */
+declare function getDefaultTempo(): Readonly<Tempo>;
+/** @public */
+declare function getTempoString(tempo: Tempo): string;
+/** @public */
+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, MaxNoteLength as h, MinNoteLength as i, validateNoteLength as v };

package/dist/tempo-TjQKn46X.d.mts

@@ -0,0 +1,120 @@
+import { N as Note, A as Accidental } from './note-B5ZtlHc8.mjs';
+
+/** @public */
+declare enum Mode {
+    Ionian = 1,
+    Dorian = 2,
+    Phrygian = 3,
+    Lydian = 4,
+    Mixolydian = 5,
+    Aeolian = 6,
+    Locrian = 7
+}
+/** @public */
+declare enum AccidentalType {
+    Natural = 0,
+    Flats = 1,
+    Sharps = 2
+}
+/** @public */
+declare function getDefaultKeySignature(): KeySignature;
+/** @public */
+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;
+}
+
+/** @public */
+declare enum NoteLength {
+    Whole = 192,// * 3 because triplets are multiplied by 2 / 3, integer result
+    Half = 96,
+    Quarter = 48,
+    Eighth = 24,
+    Sixteenth = 12,
+    ThirtySecond = 6,
+    SixtyFourth = 3
+}
+/** @public */
+declare const MaxNoteLength = NoteLength.Whole;
+/** @public */
+declare const MinNoteLength = NoteLength.SixtyFourth;
+/** @public */
+declare function validateNoteLength(noteLength: unknown): NoteLength;
+/** @public */
+declare class RhythmProps {
+    readonly noteLength: NoteLength;
+    readonly dotted: boolean;
+    readonly triplet: boolean;
+    readonly ticks: number;
+    readonly flagCount: number;
+    constructor(noteLength: NoteLength, dotted?: boolean, triplet?: boolean);
+    static createFromNoteSize(noteSize: number): RhythmProps;
+    canDot(): boolean;
+    hasStem(): boolean;
+    toString(): string;
+}
+
+/** @public */
+type TimeSignatureString = "2/4" | "3/4" | "4/4" | "6/8" | "9/8";
+/** @public */
+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;
+}
+/** @public */
+declare function getDefaultTimeSignature(): TimeSignature;
+
+/** @public */
+type Tempo = {
+    beatsPerMinute: number;
+    options: {
+        beatLength: NoteLength;
+        dotted: boolean;
+    };
+};
+/** @public */
+declare function getDefaultTempo(): Readonly<Tempo>;
+/** @public */
+declare function getTempoString(tempo: Tempo): string;
+/** @public */
+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, MaxNoteLength as h, MinNoteLength as i, validateNoteLength as v };

package/dist/theory/index.d.mts

@@ -0,0 +1,48 @@
+import { N as Note } from '../note-B5ZtlHc8.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-B5ZtlHc8.mjs';
+import { D as Degree } from '../scale-C-YS5iVG.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-C-YS5iVG.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-zASF7B1g.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-TjQKn46X.mjs';
+
+/** @public */
+type ChordInfo = {
+    name: string;
+    degrees: Degree[];
+};
+/** @public */
+declare class Chord {
+    readonly chordInfo: ChordInfo;
+    readonly rootNote: Note;
+    readonly name: string;
+    readonly notes: Note[];
+    readonly omitNotes: boolean[];
+    readonly slashBassNote?: Note;
+    private constructor();
+    static getChords(notes: ReadonlyArray<Note>): ReadonlyArray<Chord>;
+    private replaceWith;
+    /**
+     * @returns Chord name e.g. "C/B"
+     */
+    toString(): string;
+    /**
+     * @returns Degree notation string, e.g. "E - 1(C) - 3(E) - 5(G)"
+     */
+    getDegreeNotationString(): string;
+    /**
+     * @returns Omitted degrees string e.g. "Omits 5(G), 9(D)"
+     */
+    getOmittedDegreesString(): string;
+    /**
+     * @param i - Degree index
+     * @returns Degree string for given degree index, e.g. "3"
+     */
+    private getDegreeStr;
+    /**
+     * @param i - Degree index
+     * @returns Note string for given degree index, e.g. "E"
+     */
+    private getNoteStr;
+}
+
+export { Chord, type ChordInfo, Degree, Note };

package/dist/theory/index.d.ts

@@ -0,0 +1,48 @@
+import { N as Note } from '../note-B5ZtlHc8.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-B5ZtlHc8.js';
+import { D as Degree } from '../scale-B_2MZaT9.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-B_2MZaT9.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-BIFwFT31.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-DoJd-UYT.js';
+
+/** @public */
+type ChordInfo = {
+    name: string;
+    degrees: Degree[];
+};
+/** @public */
+declare class Chord {
+    readonly chordInfo: ChordInfo;
+    readonly rootNote: Note;
+    readonly name: string;
+    readonly notes: Note[];
+    readonly omitNotes: boolean[];
+    readonly slashBassNote?: Note;
+    private constructor();
+    static getChords(notes: ReadonlyArray<Note>): ReadonlyArray<Chord>;
+    private replaceWith;
+    /**
+     * @returns Chord name e.g. "C/B"
+     */
+    toString(): string;
+    /**
+     * @returns Degree notation string, e.g. "E - 1(C) - 3(E) - 5(G)"
+     */
+    getDegreeNotationString(): string;
+    /**
+     * @returns Omitted degrees string e.g. "Omits 5(G), 9(D)"
+     */
+    getOmittedDegreesString(): string;
+    /**
+     * @param i - Degree index
+     * @returns Degree string for given degree index, e.g. "3"
+     */
+    private getDegreeStr;
+    /**
+     * @param i - Degree index
+     * @returns Note string for given degree index, e.g. "E"
+     */
+    private getNoteStr;
+}
+
+export { Chord, type ChordInfo, Degree, Note };