@tspro/web-music-score 1.1.0 → 3.0.0

package/dist/scale-B_2MZaT9.d.ts

@@ -0,0 +1,87 @@
+import { N as Note, S as SymbolSet } from './note-B5ZtlHc8.js';
+import { K as KeySignature } from './tempo-DoJd-UYT.js';
+
+/** @public */
+type IntervalDirection = "Unison" | "Ascending" | "Descending";
+/** @public */
+type IntervalQuality = "Perfect" | "Major" | "minor" | "Augmented" | "Doubly Augmented" | "diminished" | "doubly diminished";
+/** @public */
+declare function validateIntervalQuality(q: string): IntervalQuality;
+/** @public */
+declare class Interval {
+    readonly note1: Note;
+    readonly note2: Note;
+    readonly direction: IntervalDirection;
+    readonly semitones: number;
+    readonly quantity: number;
+    readonly quality: IntervalQuality;
+    private constructor();
+    static get(note1: Note, note2: Note): Interval | undefined;
+    toString(): string;
+    toAbbrString(): string;
+}
+
+/** @public */
+type Degree = 1 | 2 | "b3" | 3 | 4 | "b5" | 5 | "#5" | 6 | "bb7" | "b7" | 7 | "#7" | "b9" | 9 | "#9" | 11 | 13;
+/** @public */
+declare enum ScaleType {
+    Major = "Major",
+    NaturalMinor = "Natural Minor",
+    HarmonicMinor = "Harmonic Minor",
+    Ionian = "Ionian",
+    Dorian = "Dorian",
+    Phrygian = "Phrygian",
+    Lydian = "Lydian",
+    Mixolydian = "Mixolydian",
+    Aeolian = "Aeolian",
+    Locrian = "Locrian",
+    MajorPentatonic = "Major Pentatonic",
+    MinorPentatonic = "Minor Pentatonic",
+    MajorHexatonicBlues = "Major Hexatonic Blues",
+    MinorHexatonicBlues = "Minor Hexatonic Blues",
+    HeptatonicBlues = "Heptatonic Blues"
+}
+/** @public */
+declare class Scale extends KeySignature {
+    readonly tonic: string;
+    readonly scaleType: ScaleType;
+    private readonly scaleDegrees;
+    private readonly scaleNotes;
+    private readonly chromaticClassDegree;
+    constructor(tonic: string, scaleType: ScaleType);
+    static equals(a: Scale | null | undefined, b: Scale | null | undefined): boolean;
+    getScaleName(symbolSet?: SymbolSet): string;
+    getScaleNotes(bottomNote: string, numOctaves: number): Note[];
+    getScaleOverview(): string;
+    getScaleSteps(): number[];
+    getScaleStringSteps(): string[];
+    isScaleNote(note: Note): boolean;
+    isScaleRootNote(note: Note): boolean;
+    getIntervalFromRootNote(note: Note): Interval;
+    private preferredChromaticNoteCache;
+    getPreferredChromaticNote(chromaticId: number): Note;
+}
+/** @public */
+declare class ScaleFactory {
+    readonly type: ScaleType;
+    private tonicList;
+    private scaleMap;
+    constructor(type: ScaleType);
+    getTonicList(): ReadonlyArray<string>;
+    getDefaultTonic(): string;
+    getType(): ScaleType;
+    getScale(tonic: string): Scale;
+    hasScale(tonic: string): boolean;
+}
+/** @public */
+declare function getScaleFactoryList(): ReadonlyArray<ScaleFactory | string>;
+/** @public */
+declare function getScaleFactory(scaleType: ScaleType): ScaleFactory;
+/** @public */
+declare function validateScaleType(scaleType: unknown): ScaleType;
+/** @public */
+declare function getScale(tonic: string, scaleType: ScaleType): Scale;
+/** @public */
+declare function getDefaultScale(): Scale;
+
+export { type Degree as D, type IntervalDirection as I, ScaleType as S, type IntervalQuality as a, Interval as b, Scale as c, ScaleFactory as d, getScaleFactory as e, validateScaleType as f, getScaleFactoryList as g, getScale as h, getDefaultScale as i, validateIntervalQuality as v };

package/dist/scale-C-YS5iVG.d.mts

@@ -0,0 +1,87 @@
+import { N as Note, S as SymbolSet } from './note-B5ZtlHc8.mjs';
+import { K as KeySignature } from './tempo-TjQKn46X.mjs';
+
+/** @public */
+type IntervalDirection = "Unison" | "Ascending" | "Descending";
+/** @public */
+type IntervalQuality = "Perfect" | "Major" | "minor" | "Augmented" | "Doubly Augmented" | "diminished" | "doubly diminished";
+/** @public */
+declare function validateIntervalQuality(q: string): IntervalQuality;
+/** @public */
+declare class Interval {
+    readonly note1: Note;
+    readonly note2: Note;
+    readonly direction: IntervalDirection;
+    readonly semitones: number;
+    readonly quantity: number;
+    readonly quality: IntervalQuality;
+    private constructor();
+    static get(note1: Note, note2: Note): Interval | undefined;
+    toString(): string;
+    toAbbrString(): string;
+}
+
+/** @public */
+type Degree = 1 | 2 | "b3" | 3 | 4 | "b5" | 5 | "#5" | 6 | "bb7" | "b7" | 7 | "#7" | "b9" | 9 | "#9" | 11 | 13;
+/** @public */
+declare enum ScaleType {
+    Major = "Major",
+    NaturalMinor = "Natural Minor",
+    HarmonicMinor = "Harmonic Minor",
+    Ionian = "Ionian",
+    Dorian = "Dorian",
+    Phrygian = "Phrygian",
+    Lydian = "Lydian",
+    Mixolydian = "Mixolydian",
+    Aeolian = "Aeolian",
+    Locrian = "Locrian",
+    MajorPentatonic = "Major Pentatonic",
+    MinorPentatonic = "Minor Pentatonic",
+    MajorHexatonicBlues = "Major Hexatonic Blues",
+    MinorHexatonicBlues = "Minor Hexatonic Blues",
+    HeptatonicBlues = "Heptatonic Blues"
+}
+/** @public */
+declare class Scale extends KeySignature {
+    readonly tonic: string;
+    readonly scaleType: ScaleType;
+    private readonly scaleDegrees;
+    private readonly scaleNotes;
+    private readonly chromaticClassDegree;
+    constructor(tonic: string, scaleType: ScaleType);
+    static equals(a: Scale | null | undefined, b: Scale | null | undefined): boolean;
+    getScaleName(symbolSet?: SymbolSet): string;
+    getScaleNotes(bottomNote: string, numOctaves: number): Note[];
+    getScaleOverview(): string;
+    getScaleSteps(): number[];
+    getScaleStringSteps(): string[];
+    isScaleNote(note: Note): boolean;
+    isScaleRootNote(note: Note): boolean;
+    getIntervalFromRootNote(note: Note): Interval;
+    private preferredChromaticNoteCache;
+    getPreferredChromaticNote(chromaticId: number): Note;
+}
+/** @public */
+declare class ScaleFactory {
+    readonly type: ScaleType;
+    private tonicList;
+    private scaleMap;
+    constructor(type: ScaleType);
+    getTonicList(): ReadonlyArray<string>;
+    getDefaultTonic(): string;
+    getType(): ScaleType;
+    getScale(tonic: string): Scale;
+    hasScale(tonic: string): boolean;
+}
+/** @public */
+declare function getScaleFactoryList(): ReadonlyArray<ScaleFactory | string>;
+/** @public */
+declare function getScaleFactory(scaleType: ScaleType): ScaleFactory;
+/** @public */
+declare function validateScaleType(scaleType: unknown): ScaleType;
+/** @public */
+declare function getScale(tonic: string, scaleType: ScaleType): Scale;
+/** @public */
+declare function getDefaultScale(): Scale;
+
+export { type Degree as D, type IntervalDirection as I, ScaleType as S, type IntervalQuality as a, Interval as b, Scale as c, ScaleFactory as d, getScaleFactory as e, validateScaleType as f, getScaleFactoryList as g, getScale as h, getDefaultScale as i, validateIntervalQuality as v };

package/dist/score/index.d.mts

@@ -0,0 +1,43 @@
+import { S as StaffPreset, a as ScoreConfiguration, O as ObjMeasure, M as MDocument, N as NoteOptions, R as RestOptions, F as Fermata, b as Navigation, C as Connective, T as TieType, c as NoteAnchor, L as Label, A as Annotation } from '../interface-CLb7xa7_.mjs';
+export { a3 as Arpeggio, X as Clef, a4 as ConnectiveSpan, D as DivRect, j as MAccidental, l as MArpeggio, u as MBarLineLeft, t as MBarLineRight, m as MBeamGroup, k as MConnective, o as MEnding, Q as MExtensionLine, p as MFermata, q as MHeader, r as MImage, s as MMeasure, w as MNoteGroup, W as MPlaybackButtons, U as MPlayer, V as MRenderer, z as MRest, E as MRhythmColumn, G as MScoreRow, J as MSignature, K as MSpecialText, H as MStaff, n as MStaffBeamGroup, x as MStaffNoteGroup, B as MStaffRest, v as MStaffTabBarLine, I as MTab, y as MTabNoteGroup, P as MText, i as MusicInterface, a5 as PlayState, a6 as PlayStateChangeListener, e as ScoreEvent, h as ScoreEventListener, d as ScoreEventType, g as ScoreObjectEvent, f as ScoreStaffPosEvent, Y as StaffConfig, a2 as Stem, a0 as StringNumber, Z as TabConfig, _ as VoiceId, a1 as getStringNumbers, $ as getVoiceIds } from '../interface-CLb7xa7_.mjs';
+import { N as Note } from '../note-B5ZtlHc8.mjs';
+import { S as ScaleType, c as Scale } from '../scale-C-YS5iVG.mjs';
+import { K as KeySignature, a as TimeSignature, T as TimeSignatureString, N as NoteLength } from '../tempo-TjQKn46X.mjs';
+import '@tspro/ts-utils-lib';
+
+declare class DocumentBuilder {
+    private readonly doc;
+    constructor();
+    setScoreConfiguration(staffPreset: StaffPreset): DocumentBuilder;
+    setScoreConfiguration(config: ScoreConfiguration): DocumentBuilder;
+    getMeasure(): ObjMeasure;
+    getDocument(): MDocument;
+    setHeader(title?: string, composer?: string, arranger?: string): DocumentBuilder;
+    setMeasuresPerRow(measuresPerRow: number): DocumentBuilder;
+    addMeasure(): DocumentBuilder;
+    setKeySignature(tonic: string, scaleType: ScaleType): DocumentBuilder;
+    setKeySignature(keySignature: KeySignature): DocumentBuilder;
+    setKeySignature(scale: Scale): DocumentBuilder;
+    setTimeSignature(timeSignature: TimeSignature | TimeSignatureString): DocumentBuilder;
+    setTempo(beatsPerMinute: number, beatLength?: NoteLength, dotted?: boolean): DocumentBuilder;
+    addNote(voiceId: number, note: Note | string, noteLength: NoteLength, options?: NoteOptions): DocumentBuilder;
+    addChord(voiceId: number, notes: (Note | string)[], noteLength: NoteLength, options?: NoteOptions): DocumentBuilder;
+    addRest(voiceId: number, restLength: NoteLength, options?: RestOptions): DocumentBuilder;
+    addFermata(fermata?: Fermata): DocumentBuilder;
+    addNavigation(navigation: Navigation): DocumentBuilder;
+    addNavigation(navigation: Navigation.EndRepeat, playCount: number): DocumentBuilder;
+    addNavigation(navigation: Navigation.Ending, ...passages: number[]): DocumentBuilder;
+    addConnective(connective: Connective.Tie, tieSpan?: number | TieType, notAnchor?: NoteAnchor): DocumentBuilder;
+    addConnective(connective: Connective.Slur, slurSpan?: number, notAnchor?: NoteAnchor): DocumentBuilder;
+    addConnective(connective: Connective.Slide, notAnchor?: NoteAnchor): DocumentBuilder;
+    addLabel(label: Label, text: string): DocumentBuilder;
+    addAnnotation(annotation: Annotation, text: string): DocumentBuilder;
+    addExtension(extensionLength: NoteLength | number, extensionVisible?: boolean): DocumentBuilder;
+    endSong(): DocumentBuilder;
+    endSection(): DocumentBuilder;
+    endRow(): DocumentBuilder;
+    completeRests(voiceId?: number): DocumentBuilder;
+    addScaleArpeggio(scale: Scale, bottomNote: string, numOctaves: number): DocumentBuilder;
+}
+
+export { Annotation, Connective, DocumentBuilder, Fermata, Label, MDocument, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, TieType };

package/dist/score/index.d.ts

@@ -0,0 +1,43 @@
+import { S as StaffPreset, a as ScoreConfiguration, O as ObjMeasure, M as MDocument, N as NoteOptions, R as RestOptions, F as Fermata, b as Navigation, C as Connective, T as TieType, c as NoteAnchor, L as Label, A as Annotation } from '../interface-DXyXwLBB.js';
+export { a3 as Arpeggio, X as Clef, a4 as ConnectiveSpan, D as DivRect, j as MAccidental, l as MArpeggio, u as MBarLineLeft, t as MBarLineRight, m as MBeamGroup, k as MConnective, o as MEnding, Q as MExtensionLine, p as MFermata, q as MHeader, r as MImage, s as MMeasure, w as MNoteGroup, W as MPlaybackButtons, U as MPlayer, V as MRenderer, z as MRest, E as MRhythmColumn, G as MScoreRow, J as MSignature, K as MSpecialText, H as MStaff, n as MStaffBeamGroup, x as MStaffNoteGroup, B as MStaffRest, v as MStaffTabBarLine, I as MTab, y as MTabNoteGroup, P as MText, i as MusicInterface, a5 as PlayState, a6 as PlayStateChangeListener, e as ScoreEvent, h as ScoreEventListener, d as ScoreEventType, g as ScoreObjectEvent, f as ScoreStaffPosEvent, Y as StaffConfig, a2 as Stem, a0 as StringNumber, Z as TabConfig, _ as VoiceId, a1 as getStringNumbers, $ as getVoiceIds } from '../interface-DXyXwLBB.js';
+import { N as Note } from '../note-B5ZtlHc8.js';
+import { S as ScaleType, c as Scale } from '../scale-B_2MZaT9.js';
+import { K as KeySignature, a as TimeSignature, T as TimeSignatureString, N as NoteLength } from '../tempo-DoJd-UYT.js';
+import '@tspro/ts-utils-lib';
+
+declare class DocumentBuilder {
+    private readonly doc;
+    constructor();
+    setScoreConfiguration(staffPreset: StaffPreset): DocumentBuilder;
+    setScoreConfiguration(config: ScoreConfiguration): DocumentBuilder;
+    getMeasure(): ObjMeasure;
+    getDocument(): MDocument;
+    setHeader(title?: string, composer?: string, arranger?: string): DocumentBuilder;
+    setMeasuresPerRow(measuresPerRow: number): DocumentBuilder;
+    addMeasure(): DocumentBuilder;
+    setKeySignature(tonic: string, scaleType: ScaleType): DocumentBuilder;
+    setKeySignature(keySignature: KeySignature): DocumentBuilder;
+    setKeySignature(scale: Scale): DocumentBuilder;
+    setTimeSignature(timeSignature: TimeSignature | TimeSignatureString): DocumentBuilder;
+    setTempo(beatsPerMinute: number, beatLength?: NoteLength, dotted?: boolean): DocumentBuilder;
+    addNote(voiceId: number, note: Note | string, noteLength: NoteLength, options?: NoteOptions): DocumentBuilder;
+    addChord(voiceId: number, notes: (Note | string)[], noteLength: NoteLength, options?: NoteOptions): DocumentBuilder;
+    addRest(voiceId: number, restLength: NoteLength, options?: RestOptions): DocumentBuilder;
+    addFermata(fermata?: Fermata): DocumentBuilder;
+    addNavigation(navigation: Navigation): DocumentBuilder;
+    addNavigation(navigation: Navigation.EndRepeat, playCount: number): DocumentBuilder;
+    addNavigation(navigation: Navigation.Ending, ...passages: number[]): DocumentBuilder;
+    addConnective(connective: Connective.Tie, tieSpan?: number | TieType, notAnchor?: NoteAnchor): DocumentBuilder;
+    addConnective(connective: Connective.Slur, slurSpan?: number, notAnchor?: NoteAnchor): DocumentBuilder;
+    addConnective(connective: Connective.Slide, notAnchor?: NoteAnchor): DocumentBuilder;
+    addLabel(label: Label, text: string): DocumentBuilder;
+    addAnnotation(annotation: Annotation, text: string): DocumentBuilder;
+    addExtension(extensionLength: NoteLength | number, extensionVisible?: boolean): DocumentBuilder;
+    endSong(): DocumentBuilder;
+    endSection(): DocumentBuilder;
+    endRow(): DocumentBuilder;
+    completeRests(voiceId?: number): DocumentBuilder;
+    addScaleArpeggio(scale: Scale, bottomNote: string, numOctaves: number): DocumentBuilder;
+}
+
+export { Annotation, Connective, DocumentBuilder, Fermata, Label, MDocument, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, TieType };