@hymnbook/abc 0.0.0

package/README.md

@@ -0,0 +1,3 @@
+# @hymnbook/abc
+
+This package gives support for working with ABC notation files in Hymnbook/jSchedule projects. It is not meant for public use outside of these projects.

package/dist/index.d.mts

@@ -0,0 +1,256 @@
+import { SynthOptions } from 'abcjs';
+
+type AccidentalName = "flat" | "natural" | "sharp" | "dblsharp" | "dblflat" | "quarterflat" | "quartersharp";
+type ChordPlacement = "above" | "below" | "left" | "right" | "default";
+type StemDirection = "up" | "down" | "auto" | "none";
+type AbcType = "bar_thin" | "bar_thin_thick" | "bar_thin_thin" | "bar_thick_thin" | "bar_right_repeat" | "bar_left_repeat" | "bar_double_repeat";
+type AbcElementType = "note" | "bar";
+type Clef = "treble" | "tenor" | "bass" | "alto" | "treble+8" | "tenor+8" | "bass+8" | "alto+8" | "treble-8" | "tenor-8" | "bass-8" | "alto-8" | "none" | "perc";
+type NoteHeadType = "normal" | "harmonic" | "rhythm" | "x" | "triangle";
+type NoteLetter = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "a" | "b" | "c" | "d" | "e" | "f" | "g";
+type KeyRoot = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "HP" | "Hp" | "none";
+type KeyAccidentalName = "" | "#" | "b";
+type Mode = "" | "m" | "Dor" | "Mix" | "Loc" | "Phr" | "Lyd";
+type ChordType = "" | "m" | "7" | "m7" | "maj7" | "M7" | "6" | "m6" | "aug" | "+" | "aug7" | "dim" | "dim7" | "9" | "m9" | "maj9" | "M9" | "11" | "dim9" | "sus" | "sus9" | "7sus4" | "7sus9" | "5";
+type BracePosition = "start" | "continue" | "end";
+type NumberFunction = () => number;
+interface AbcChord {
+    name: string;
+    position: ChordPlacement;
+}
+interface AbcPitchStartSlur {
+    label: number;
+}
+interface AbcPitch {
+    pitch: number;
+    verticalPos: number;
+    name?: string;
+    accidental?: AccidentalName;
+    startTie?: {};
+    endTie?: boolean;
+    startSlur?: AbcPitchStartSlur[];
+    endSlur?: number[];
+}
+interface AbcRest {
+    type: "rest" | "whole" | "multimeasure" | "spacer";
+    text?: number;
+}
+interface AbcLyric {
+    syllable: string;
+    divider: " " | "-" | "_";
+}
+interface VoiceItemBar {
+    el_type: "bar";
+    type: AbcType;
+    startChar: number;
+    endChar: number;
+}
+interface NoteProperties {
+    duration: number;
+    pitches?: AbcPitch[];
+    lyric?: AbcLyric[];
+    chord?: AbcChord[];
+    rest?: AbcRest;
+}
+interface VoiceItemNote extends NoteProperties {
+    el_type: "note";
+    startChar: number;
+    endChar: number;
+}
+interface VoiceItemStem {
+    el_type: "stem";
+    direction: StemDirection;
+}
+interface VoiceItemClef {
+    el_type: "clef";
+    stafflines?: number;
+    staffscale?: number;
+    transpose?: number;
+    type: Clef;
+    verticalPos: number;
+    clefPos?: number;
+    startChar: number;
+    endChar: number;
+}
+interface VoiceItemGap {
+    el_type: "gap";
+    gap: number;
+}
+interface VoiceItemKey extends KeySignature {
+    el_type: "key";
+    startChar: number;
+    endChar: number;
+}
+type VoiceItem = VoiceItemClef | VoiceItemBar | VoiceItemGap | VoiceItemKey | VoiceItemStem | VoiceItemNote;
+interface Accidental {
+    acc: AccidentalName;
+    note: NoteLetter;
+    verticalPos: number;
+}
+interface AbcClef {
+    clefPos: number;
+    type: Clef;
+    verticalPos: number;
+}
+interface KeySignature {
+    accidentals?: Array<Accidental>;
+    root: KeyRoot;
+    acc: KeyAccidentalName;
+    mode: Mode;
+}
+interface AbcStaff {
+    barNumber?: number;
+    brace: BracePosition;
+    bracket: BracePosition;
+    connectBarLines: BracePosition;
+    stafflines?: number;
+    clef?: AbcClef;
+    key?: KeySignature;
+    voices?: Array<Array<VoiceItem>>;
+}
+interface AbcLine {
+    staff?: AbcStaff[];
+}
+interface MetaText {
+    "abc-copyright"?: string;
+    "abc-creator"?: string;
+    "abc-version"?: string;
+    "abc-charset"?: string;
+    "abc-edited-by"?: string;
+    author?: string;
+    book?: string;
+    composer?: string;
+    discography?: string;
+    footer?: {
+        left: string;
+        center: string;
+        right: string;
+    };
+    group?: string;
+    header?: {
+        left: string;
+        center: string;
+        right: string;
+    };
+    history?: string;
+    instruction?: string;
+    measurebox?: boolean;
+    notes?: string;
+    origin?: string;
+    partOrder?: string;
+    rhythm?: string;
+    source?: string;
+    textBlock?: string;
+    title?: string;
+    transcription?: string;
+    url?: string;
+}
+interface TuneObject {
+    formatting: object;
+    media: string;
+    version: string;
+    metaText: MetaText;
+    lines: AbcLine[];
+    getTotalTime: NumberFunction;
+    getTotalBeats: NumberFunction;
+    getBarLength: NumberFunction;
+    getBeatLength: NumberFunction;
+    getBeatsPerMeasure: NumberFunction;
+    getBpm: NumberFunction;
+    getPickupLength: NumberFunction;
+    getKeySignature: () => KeySignature;
+    getElementFromChar: (charPos: number) => VoiceItem | null;
+    millisecondsPerMeasure: NumberFunction;
+    lineBreaks?: Array<number>;
+    visualTranspose?: number;
+    setUpAudio: (options?: SynthOptions) => AudioTracks;
+}
+interface AudioTracks {
+    tempo: number;
+    instrument: number;
+    tracks: AudioTrack[][];
+    totalDuration: number;
+}
+type AudioTrack = AudioTrackProgram | AudioTrackText | AudioTrackNote;
+interface AudioTrackProgram {
+    cmd: "program";
+    channel: number;
+}
+interface AudioTrackText {
+    cmd: "text";
+}
+interface AudioTrackNote {
+    cmd: "note";
+    duration: number;
+    volume: number;
+    pitch: number;
+    gap: number;
+    instrument: number;
+    start: number;
+    startChar: number;
+    endChar: number;
+}
+declare class AbcSong {
+    area?: string;
+    book?: string;
+    composer?: string;
+    discography?: string;
+    fileUrl?: string;
+    group?: string;
+    history?: string;
+    instruction?: string;
+    key?: string;
+    unitNoteLength?: string;
+    meter?: string;
+    macro?: string;
+    notes?: string;
+    origin?: string;
+    parts?: string;
+    tempo?: string;
+    rhythm?: string;
+    remark?: string;
+    source?: string;
+    symbolLine?: string;
+    title?: string;
+    userDefined?: string;
+    voice?: string;
+    referenceNumber?: string;
+    transcription?: string;
+    melody: VoiceItem[][];
+    clef: AbcClef;
+    keySignature: KeySignature;
+}
+interface NoteGroupInterface {
+    notes: string;
+    lyrics: string;
+}
+
+declare const parse: (abc: string) => AbcSong | undefined;
+declare const getField: (abc: string, field: string, _default?: string) => (string | undefined);
+declare const extractInfoFields: (abc: string, song: AbcSong) => string;
+declare const extractNotesAndLyrics: (abc: string) => NoteGroupInterface;
+declare const addInfoFieldsToMelody: (song: AbcSong, abc: string) => string;
+declare const convertStringToAbcTune: (abc: string) => TuneObject;
+declare const combineMelodyAndLyrics: (melody: string, lyrics: string) => string;
+
+type Verse = {
+    uuid: string;
+    abcLyrics?: string;
+};
+type AbcSubMelody = {
+    melody: string;
+    verseUuids: string[];
+};
+type AbcMelody = {
+    melody: string;
+    subMelodies: AbcSubMelody[];
+};
+
+declare const getForVerse: (melody: AbcMelody, verse: Verse) => AbcSubMelody | undefined;
+declare const generateAbcForVerse: (verse: Verse, activeMelody?: AbcMelody) => string;
+
+declare class ValidationError extends Error {
+}
+declare function validate(result: boolean, message?: string): void;
+
+export { type AbcChord, type AbcClef, type AbcElementType, type AbcLine, type AbcLyric, type AbcMelody, type AbcPitch, type AbcPitchStartSlur, type AbcRest, AbcSong, type AbcStaff, type AbcSubMelody, type AbcType, type Accidental, type AccidentalName, type AudioTrack, type AudioTrackNote, type AudioTrackProgram, type AudioTrackText, type AudioTracks, type BracePosition, type ChordPlacement, type ChordType, type Clef, type KeyAccidentalName, type KeyRoot, type KeySignature, type MetaText, type Mode, type NoteGroupInterface, type NoteHeadType, type NoteLetter, type NoteProperties, type StemDirection, type TuneObject, ValidationError, type Verse, type VoiceItem, type VoiceItemBar, type VoiceItemClef, type VoiceItemGap, type VoiceItemKey, type VoiceItemNote, type VoiceItemStem, addInfoFieldsToMelody, combineMelodyAndLyrics, convertStringToAbcTune, extractInfoFields, extractNotesAndLyrics, generateAbcForVerse, getField, getForVerse, parse, validate };

package/dist/index.d.ts

@@ -0,0 +1,256 @@
+import { SynthOptions } from 'abcjs';
+
+type AccidentalName = "flat" | "natural" | "sharp" | "dblsharp" | "dblflat" | "quarterflat" | "quartersharp";
+type ChordPlacement = "above" | "below" | "left" | "right" | "default";
+type StemDirection = "up" | "down" | "auto" | "none";
+type AbcType = "bar_thin" | "bar_thin_thick" | "bar_thin_thin" | "bar_thick_thin" | "bar_right_repeat" | "bar_left_repeat" | "bar_double_repeat";
+type AbcElementType = "note" | "bar";
+type Clef = "treble" | "tenor" | "bass" | "alto" | "treble+8" | "tenor+8" | "bass+8" | "alto+8" | "treble-8" | "tenor-8" | "bass-8" | "alto-8" | "none" | "perc";
+type NoteHeadType = "normal" | "harmonic" | "rhythm" | "x" | "triangle";
+type NoteLetter = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "a" | "b" | "c" | "d" | "e" | "f" | "g";
+type KeyRoot = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "HP" | "Hp" | "none";
+type KeyAccidentalName = "" | "#" | "b";
+type Mode = "" | "m" | "Dor" | "Mix" | "Loc" | "Phr" | "Lyd";
+type ChordType = "" | "m" | "7" | "m7" | "maj7" | "M7" | "6" | "m6" | "aug" | "+" | "aug7" | "dim" | "dim7" | "9" | "m9" | "maj9" | "M9" | "11" | "dim9" | "sus" | "sus9" | "7sus4" | "7sus9" | "5";
+type BracePosition = "start" | "continue" | "end";
+type NumberFunction = () => number;
+interface AbcChord {
+    name: string;
+    position: ChordPlacement;
+}
+interface AbcPitchStartSlur {
+    label: number;
+}
+interface AbcPitch {
+    pitch: number;
+    verticalPos: number;
+    name?: string;
+    accidental?: AccidentalName;
+    startTie?: {};
+    endTie?: boolean;
+    startSlur?: AbcPitchStartSlur[];
+    endSlur?: number[];
+}
+interface AbcRest {
+    type: "rest" | "whole" | "multimeasure" | "spacer";
+    text?: number;
+}
+interface AbcLyric {
+    syllable: string;
+    divider: " " | "-" | "_";
+}
+interface VoiceItemBar {
+    el_type: "bar";
+    type: AbcType;
+    startChar: number;
+    endChar: number;
+}
+interface NoteProperties {
+    duration: number;
+    pitches?: AbcPitch[];
+    lyric?: AbcLyric[];
+    chord?: AbcChord[];
+    rest?: AbcRest;
+}
+interface VoiceItemNote extends NoteProperties {
+    el_type: "note";
+    startChar: number;
+    endChar: number;
+}
+interface VoiceItemStem {
+    el_type: "stem";
+    direction: StemDirection;
+}
+interface VoiceItemClef {
+    el_type: "clef";
+    stafflines?: number;
+    staffscale?: number;
+    transpose?: number;
+    type: Clef;
+    verticalPos: number;
+    clefPos?: number;
+    startChar: number;
+    endChar: number;
+}
+interface VoiceItemGap {
+    el_type: "gap";
+    gap: number;
+}
+interface VoiceItemKey extends KeySignature {
+    el_type: "key";
+    startChar: number;
+    endChar: number;
+}
+type VoiceItem = VoiceItemClef | VoiceItemBar | VoiceItemGap | VoiceItemKey | VoiceItemStem | VoiceItemNote;
+interface Accidental {
+    acc: AccidentalName;
+    note: NoteLetter;
+    verticalPos: number;
+}
+interface AbcClef {
+    clefPos: number;
+    type: Clef;
+    verticalPos: number;
+}
+interface KeySignature {
+    accidentals?: Array<Accidental>;
+    root: KeyRoot;
+    acc: KeyAccidentalName;
+    mode: Mode;
+}
+interface AbcStaff {
+    barNumber?: number;
+    brace: BracePosition;
+    bracket: BracePosition;
+    connectBarLines: BracePosition;
+    stafflines?: number;
+    clef?: AbcClef;
+    key?: KeySignature;
+    voices?: Array<Array<VoiceItem>>;
+}
+interface AbcLine {
+    staff?: AbcStaff[];
+}
+interface MetaText {
+    "abc-copyright"?: string;
+    "abc-creator"?: string;
+    "abc-version"?: string;
+    "abc-charset"?: string;
+    "abc-edited-by"?: string;
+    author?: string;
+    book?: string;
+    composer?: string;
+    discography?: string;
+    footer?: {
+        left: string;
+        center: string;
+        right: string;
+    };
+    group?: string;
+    header?: {
+        left: string;
+        center: string;
+        right: string;
+    };
+    history?: string;
+    instruction?: string;
+    measurebox?: boolean;
+    notes?: string;
+    origin?: string;
+    partOrder?: string;
+    rhythm?: string;
+    source?: string;
+    textBlock?: string;
+    title?: string;
+    transcription?: string;
+    url?: string;
+}
+interface TuneObject {
+    formatting: object;
+    media: string;
+    version: string;
+    metaText: MetaText;
+    lines: AbcLine[];
+    getTotalTime: NumberFunction;
+    getTotalBeats: NumberFunction;
+    getBarLength: NumberFunction;
+    getBeatLength: NumberFunction;
+    getBeatsPerMeasure: NumberFunction;
+    getBpm: NumberFunction;
+    getPickupLength: NumberFunction;
+    getKeySignature: () => KeySignature;
+    getElementFromChar: (charPos: number) => VoiceItem | null;
+    millisecondsPerMeasure: NumberFunction;
+    lineBreaks?: Array<number>;
+    visualTranspose?: number;
+    setUpAudio: (options?: SynthOptions) => AudioTracks;
+}
+interface AudioTracks {
+    tempo: number;
+    instrument: number;
+    tracks: AudioTrack[][];
+    totalDuration: number;
+}
+type AudioTrack = AudioTrackProgram | AudioTrackText | AudioTrackNote;
+interface AudioTrackProgram {
+    cmd: "program";
+    channel: number;
+}
+interface AudioTrackText {
+    cmd: "text";
+}
+interface AudioTrackNote {
+    cmd: "note";
+    duration: number;
+    volume: number;
+    pitch: number;
+    gap: number;
+    instrument: number;
+    start: number;
+    startChar: number;
+    endChar: number;
+}
+declare class AbcSong {
+    area?: string;
+    book?: string;
+    composer?: string;
+    discography?: string;
+    fileUrl?: string;
+    group?: string;
+    history?: string;
+    instruction?: string;
+    key?: string;
+    unitNoteLength?: string;
+    meter?: string;
+    macro?: string;
+    notes?: string;
+    origin?: string;
+    parts?: string;
+    tempo?: string;
+    rhythm?: string;
+    remark?: string;
+    source?: string;
+    symbolLine?: string;
+    title?: string;
+    userDefined?: string;
+    voice?: string;
+    referenceNumber?: string;
+    transcription?: string;
+    melody: VoiceItem[][];
+    clef: AbcClef;
+    keySignature: KeySignature;
+}
+interface NoteGroupInterface {
+    notes: string;
+    lyrics: string;
+}
+
+declare const parse: (abc: string) => AbcSong | undefined;
+declare const getField: (abc: string, field: string, _default?: string) => (string | undefined);
+declare const extractInfoFields: (abc: string, song: AbcSong) => string;
+declare const extractNotesAndLyrics: (abc: string) => NoteGroupInterface;
+declare const addInfoFieldsToMelody: (song: AbcSong, abc: string) => string;
+declare const convertStringToAbcTune: (abc: string) => TuneObject;
+declare const combineMelodyAndLyrics: (melody: string, lyrics: string) => string;
+
+type Verse = {
+    uuid: string;
+    abcLyrics?: string;
+};
+type AbcSubMelody = {
+    melody: string;
+    verseUuids: string[];
+};
+type AbcMelody = {
+    melody: string;
+    subMelodies: AbcSubMelody[];
+};
+
+declare const getForVerse: (melody: AbcMelody, verse: Verse) => AbcSubMelody | undefined;
+declare const generateAbcForVerse: (verse: Verse, activeMelody?: AbcMelody) => string;
+
+declare class ValidationError extends Error {
+}
+declare function validate(result: boolean, message?: string): void;
+
+export { type AbcChord, type AbcClef, type AbcElementType, type AbcLine, type AbcLyric, type AbcMelody, type AbcPitch, type AbcPitchStartSlur, type AbcRest, AbcSong, type AbcStaff, type AbcSubMelody, type AbcType, type Accidental, type AccidentalName, type AudioTrack, type AudioTrackNote, type AudioTrackProgram, type AudioTrackText, type AudioTracks, type BracePosition, type ChordPlacement, type ChordType, type Clef, type KeyAccidentalName, type KeyRoot, type KeySignature, type MetaText, type Mode, type NoteGroupInterface, type NoteHeadType, type NoteLetter, type NoteProperties, type StemDirection, type TuneObject, ValidationError, type Verse, type VoiceItem, type VoiceItemBar, type VoiceItemClef, type VoiceItemGap, type VoiceItemKey, type VoiceItemNote, type VoiceItemStem, addInfoFieldsToMelody, combineMelodyAndLyrics, convertStringToAbcTune, extractInfoFields, extractNotesAndLyrics, generateAbcForVerse, getField, getForVerse, parse, validate };