@hymnbook/abc 0.0.0 → 0.1.1

package/dist/{index.mjs → index.cjs}

@@ -1,4 +1,52 @@
-// src/abcTypes.ts
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AbcSong: () => AbcSong,
+  ValidationError: () => ValidationError,
+  addInfoFieldsToMelody: () => addInfoFieldsToMelody,
+  combineMelodyAndLyrics: () => combineMelodyAndLyrics,
+  convertStringToAbcTune: () => convertStringToAbcTune,
+  extractInfoFields: () => extractInfoFields,
+  generateAbcForVerse: () => generateAbcForVerse,
+  getField: () => getField,
+  getForVerse: () => getForVerse,
+  parse: () => parse,
+  squashNotesAndLyrics: () => squashNotesAndLyrics,
+  stringify: () => stringify,
+  validate: () => validate
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/types.ts
 var AbcSong = class {
   // See also: https://abcnotation.com/wiki/abc:standard:v2.1#information_fields
   area;
@@ -40,8 +88,8 @@ var AbcSong = class {
   };
 };
 
-// src/abc.ts
-import * as ABCJS from "abcjs";
+// src/parser.ts
+var ABCJS = __toESM(require("abcjs"), 1);
 
 // src/validation.ts
 var ValidationError = class extends Error {
@@ -53,15 +101,155 @@ function validate(result, message) {
   throw new ValidationError(message || "Value is not true");
 }
 
-// src/abc.ts
+// src/deparser.ts
+var addInfoFieldsToMelody = (song, abc) => {
+  let result = "";
+  result += song.referenceNumber === void 0 ? "" : "X:" + song.referenceNumber + "\n";
+  result += song.title === void 0 ? "" : "T:" + song.title + "\n";
+  result += song.area === void 0 ? "" : "A:" + song.area + "\n";
+  result += song.book === void 0 ? "" : "B:" + song.book + "\n";
+  result += song.composer === void 0 ? "" : "C:" + song.composer + "\n";
+  result += song.discography === void 0 ? "" : "D:" + song.discography + "\n";
+  result += song.fileUrl === void 0 ? "" : "F:" + song.fileUrl + "\n";
+  result += song.group === void 0 ? "" : "G:" + song.group + "\n";
+  result += song.history === void 0 ? "" : "H:" + song.history + "\n";
+  result += song.instruction === void 0 ? "" : "I:" + song.instruction + "\n";
+  result += song.key === void 0 ? "" : "K:" + song.key + "\n";
+  result += song.unitNoteLength === void 0 ? "" : "L:" + song.unitNoteLength + "\n";
+  result += song.meter === void 0 ? "" : "M:" + song.meter + "\n";
+  result += song.macro === void 0 ? "" : "m:" + song.macro + "\n";
+  result += song.notes === void 0 ? "" : "N:" + song.notes + "\n";
+  result += song.origin === void 0 ? "" : "O:" + song.origin + "\n";
+  result += song.parts === void 0 ? "" : "P:" + song.parts + "\n";
+  result += song.tempo === void 0 ? "" : "Q:" + song.tempo + "\n";
+  result += song.rhythm === void 0 ? "" : "R:" + song.rhythm + "\n";
+  result += song.remark === void 0 ? "" : "r:" + song.remark + "\n";
+  result += song.source === void 0 ? "" : "S:" + song.source + "\n";
+  result += song.symbolLine === void 0 ? "" : "s:" + song.symbolLine + "\n";
+  result += song.userDefined === void 0 ? "" : "U:" + song.userDefined + "\n";
+  result += song.voice === void 0 ? "" : "V:" + song.voice + "\n";
+  result += song.transcription === void 0 ? "" : "Z:" + song.transcription + "\n";
+  return result + abc;
+};
+var durationToString = (duration) => {
+  duration /= 4;
+  if (duration > 3 / 8) return (duration * 4).toString();
+  if (duration == 1 / 4) return "";
+  if (duration == 3 / 8) return "3/2";
+  if (duration == 1 / 8) return "/2";
+  if (duration == 3 / 16) return "3/4";
+  if (duration == 1 / 16) return "/4";
+  if (duration == 3 / 32) return "3/8";
+  if (duration == 1 / 32) return "/8";
+  if (duration == 3 / 64) return "3/16";
+  return "";
+};
+var voiceBarToString = (voice) => {
+  let result = "";
+  switch (voice.type) {
+    case "bar_thin":
+      result += "|";
+      break;
+    case "bar_thin_thick":
+      result += "|]";
+      break;
+    case "bar_thin_thin":
+      result += "||";
+      break;
+    case "bar_thick_thin":
+      result += "[|";
+      break;
+    case "bar_right_repeat":
+      result += ":|";
+      break;
+    case "bar_left_repeat":
+      result += "|:";
+      break;
+    case "bar_dbl_repeat":
+      result += "::";
+      break;
+  }
+  if (voice.startEnding) result += voice.startEnding;
+  return result + " ";
+};
+var voiceNoteToString = (voice, durationMultiplier, isBeam) => {
+  let notes = "";
+  let lyrics = "";
+  const duration = durationToString(voice.duration / durationMultiplier);
+  if (voice.startBeam) isBeam = true;
+  if (voice.endBeam) isBeam = false;
+  voice.chord?.forEach((chord) => {
+    const parsedChordName = chord.name.replaceAll(/♭/g, "b").replaceAll(/♯/g, "#");
+    notes += `"${parsedChordName}"`;
+  });
+  if (voice.pitches && voice.pitches?.length > 1) notes += "[";
+  voice.pitches?.forEach((pitch) => {
+    let note = pitch.name + duration;
+    if (pitch.startSlur) note = "(".repeat(pitch.startSlur.length) + note;
+    if (pitch.endSlur) note += ")".repeat(pitch.endSlur.length);
+    if (pitch.startTie) note += "-";
+    notes += note;
+  });
+  if (voice.pitches && voice.pitches?.length > 1) notes += "]";
+  if (voice.rest) {
+    if (voice.rest.type == "spacer") {
+      notes += "y";
+    } else if (voice.rest.type == "multimeasure") {
+      notes += "Z" + durationToString(voice.duration / 4);
+    } else {
+      notes += "z" + duration;
+    }
+  }
+  if (voice.pitches) {
+    voice.lyric?.forEach((lyric) => {
+      let text = lyric.syllable.replace(/ /g, "~");
+      if (text == "") text = "*";
+      lyrics += text + lyric.divider;
+    });
+  }
+  if (!isBeam) notes += " ";
+  return {
+    notes,
+    lyrics,
+    isBeam
+  };
+};
+var stringify = (song) => {
+  const durationParts = (song.unitNoteLength || "1/8").split("/");
+  const durationMultiplier = durationParts.length > 1 ? +durationParts[0] / +durationParts[1] : +durationParts[0];
+  const melody = song.melody.flatMap((line) => {
+    const notes = [];
+    const lyrics = [];
+    let isBeam = false;
+    line.forEach((voice) => {
+      switch (voice.el_type) {
+        case "bar":
+          notes.push(voiceBarToString(voice));
+          break;
+        case "note":
+          const result2 = voiceNoteToString(voice, durationMultiplier, isBeam);
+          notes.push(result2.notes);
+          lyrics.push(result2.lyrics);
+          isBeam = result2.isBeam;
+          break;
+      }
+    });
+    const result = [notes.join("").trim()];
+    const mergedLyrics = lyrics.join("").trim();
+    if (mergedLyrics.length > 0) {
+      result.push("w: " + mergedLyrics);
+    }
+    return result;
+  }).join("\n");
+  return addInfoFieldsToMelody(song, melody);
+};
+
+// src/parser.ts
 var parse = (abc) => {
   abc = abc.replace(/%.*/g, "").replaceAll(/\n+/g, "\n");
   const song = new AbcSong();
   extractInfoFields(abc, song);
   const tuneObject = convertStringToAbcTune(abc);
-  if (tuneObject === void 0) {
-    return void 0;
-  }
   song.clef = tuneObject.lines[0].staff[0].clef || song.clef;
   song.keySignature = tuneObject.lines[0].staff[0].key || song.keySignature;
   song.melody = tuneObject.lines.map((line) => line.staff[0].voices[0]);
@@ -149,7 +337,7 @@ var extractInfoFields = (abc, song) => {
   song.transcription = getField(abc, "Z");
   return abc.replace(/%.*\n/g, "").replace(/(^|\n) *\t*[ABCDFGHIKLMmNOPQRrSsTUVXZ]:.*/g, "").replace(/\n+/g, "\n").replace(/^\n*/g, "").replace(/\n*$/g, "");
 };
-var extractNotesAndLyrics = (abc) => {
+var squashNotesAndLyrics = (abc) => {
   const notes = [];
   const lyrics = [];
   abc.split("\n").map((it) => it.trim()).forEach((it) => {
@@ -164,41 +352,13 @@ var extractNotesAndLyrics = (abc) => {
     lyrics: lyrics.join(" ")
   };
 };
-var addInfoFieldsToMelody = (song, abc) => {
-  let result = "";
-  result += song.referenceNumber === void 0 ? "" : "X:" + song.referenceNumber + "\n";
-  result += song.title === void 0 ? "" : "T:" + song.title + "\n";
-  result += song.area === void 0 ? "" : "A:" + song.area + "\n";
-  result += song.book === void 0 ? "" : "B:" + song.book + "\n";
-  result += song.composer === void 0 ? "" : "C:" + song.composer + "\n";
-  result += song.discography === void 0 ? "" : "D:" + song.discography + "\n";
-  result += song.fileUrl === void 0 ? "" : "F:" + song.fileUrl + "\n";
-  result += song.group === void 0 ? "" : "G:" + song.group + "\n";
-  result += song.history === void 0 ? "" : "H:" + song.history + "\n";
-  result += song.instruction === void 0 ? "" : "I:" + song.instruction + "\n";
-  result += song.key === void 0 ? "" : "K:" + song.key + "\n";
-  result += song.unitNoteLength === void 0 ? "" : "L:" + song.unitNoteLength + "\n";
-  result += song.meter === void 0 ? "" : "M:" + song.meter + "\n";
-  result += song.macro === void 0 ? "" : "m:" + song.macro + "\n";
-  result += song.notes === void 0 ? "" : "N:" + song.notes + "\n";
-  result += song.origin === void 0 ? "" : "O:" + song.origin + "\n";
-  result += song.parts === void 0 ? "" : "P:" + song.parts + "\n";
-  result += song.tempo === void 0 ? "" : "Q:" + song.tempo + "\n";
-  result += song.rhythm === void 0 ? "" : "R:" + song.rhythm + "\n";
-  result += song.remark === void 0 ? "" : "r:" + song.remark + "\n";
-  result += song.source === void 0 ? "" : "S:" + song.source + "\n";
-  result += song.symbolLine === void 0 ? "" : "s:" + song.symbolLine + "\n";
-  result += song.userDefined === void 0 ? "" : "U:" + song.userDefined + "\n";
-  result += song.voice === void 0 ? "" : "V:" + song.voice + "\n";
-  result += song.transcription === void 0 ? "" : "Z:" + song.transcription + "\n";
-  return result + abc;
-};
 var convertStringToAbcTune = (abc) => {
   const objectArray = ABCJS.parseOnly(abc);
   const object = objectArray;
   validate(object != null, "Tune object may not be null");
   validate(object.length > 0, "Tune object may not be empty");
   validate(object[0].lines != null, "Tune object lines may not be null");
+  object[0].lines = object[0].lines.filter((it) => it.staff);
   validate(object[0].lines.length > 0, "Tune object lines are empty");
   validate(object[0].lines[0].staff != null, "Staffs may not be null");
   validate(object[0].lines[0].staff.length > 0, "Staffs are empty");
@@ -246,17 +406,19 @@ var generateAbcForVerse = (verse, activeMelody) => {
   const melody = getForVerse(activeMelody, verse)?.melody || activeMelody.melody;
   return combineMelodyAndLyrics(melody, verse.abcLyrics || "");
 };
-export {
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
   AbcSong,
   ValidationError,
   addInfoFieldsToMelody,
   combineMelodyAndLyrics,
   convertStringToAbcTune,
   extractInfoFields,
-  extractNotesAndLyrics,
   generateAbcForVerse,
   getField,
   getForVerse,
   parse,
+  squashNotesAndLyrics,
+  stringify,
   validate
-};
+});

package/dist/{index.d.mts → index.d.cts}

@@ -3,7 +3,7 @@ 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 AbcType = "bar_thin" | "bar_thin_thick" | "bar_thin_thin" | "bar_thick_thin" | "bar_right_repeat" | "bar_left_repeat" | "bar_dbl_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";
@@ -44,6 +44,7 @@ interface VoiceItemBar {
     type: AbcType;
     startChar: number;
     endChar: number;
+    startEnding?: string;
 }
 interface NoteProperties {
     duration: number;
@@ -51,6 +52,8 @@ interface NoteProperties {
     lyric?: AbcLyric[];
     chord?: AbcChord[];
     rest?: AbcRest;
+    startBeam?: boolean;
+    endBeam?: boolean;
 }
 interface VoiceItemNote extends NoteProperties {
     el_type: "note";
@@ -220,17 +223,48 @@ declare class AbcSong {
     clef: AbcClef;
     keySignature: KeySignature;
 }
-interface NoteGroupInterface {
+type NoteGroupInterface = {
     notes: string;
     lyrics: string;
-}
+};
 
-declare const parse: (abc: string) => AbcSong | undefined;
+/**
+ * Generates an AbcSong object from an ABC notation string.
+ * This function does some extra processing to handle slurs and lyrics properly.
+ * If you do not want this, use `convertStringToAbcTune` directly.
+ *
+ * @param abc
+ */
+declare const parse: (abc: string) => AbcSong;
+/**
+ * Get an info/header field from an ABC notation string.
+ * @param abc
+ * @param field
+ * @param _default
+ */
 declare const getField: (abc: string, field: string, _default?: string) => (string | undefined);
+/**
+ * Extract info/header fields from an ABC notation string into an AbcSong object and return the remaining melody string.
+ * @param abc
+ * @param song
+ */
 declare const extractInfoFields: (abc: string, song: AbcSong) => string;
-declare const extractNotesAndLyrics: (abc: string) => NoteGroupInterface;
-declare const addInfoFieldsToMelody: (song: AbcSong, abc: string) => string;
+/**
+ * Extract notes and lyrics from an ABC notation string as a single line for each.
+ * Note that you must first remove info/header fields before using this function.
+ * @param abc
+ */
+declare const squashNotesAndLyrics: (abc: string) => NoteGroupInterface;
+/**
+ * Converts and validates an ABC notation string into a TuneObject.
+ * @param abc
+ */
 declare const convertStringToAbcTune: (abc: string) => TuneObject;
+/**
+ * Combine multi line lyrics line with a multi line melody into a single ABC notation string.
+ * @param melody
+ * @param lyrics
+ */
 declare const combineMelodyAndLyrics: (melody: string, lyrics: string) => string;
 
 type Verse = {
@@ -253,4 +287,16 @@ 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 };
+/**
+ * Converts an AbcSong object's info fields to ABC notation and merges them with the given melody string.
+ * @param song
+ * @param abc
+ */
+declare const addInfoFieldsToMelody: (song: AbcSong, abc: string) => string;
+/**
+ * Convert an AbcSong object to an ABC notation string.
+ * @param song
+ */
+declare const stringify: (song: AbcSong) => string;
+
+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, generateAbcForVerse, getField, getForVerse, parse, squashNotesAndLyrics, stringify, validate };

package/dist/index.d.ts

@@ -3,7 +3,7 @@ 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 AbcType = "bar_thin" | "bar_thin_thick" | "bar_thin_thin" | "bar_thick_thin" | "bar_right_repeat" | "bar_left_repeat" | "bar_dbl_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";
@@ -44,6 +44,7 @@ interface VoiceItemBar {
     type: AbcType;
     startChar: number;
     endChar: number;
+    startEnding?: string;
 }
 interface NoteProperties {
     duration: number;
@@ -51,6 +52,8 @@ interface NoteProperties {
     lyric?: AbcLyric[];
     chord?: AbcChord[];
     rest?: AbcRest;
+    startBeam?: boolean;
+    endBeam?: boolean;
 }
 interface VoiceItemNote extends NoteProperties {
     el_type: "note";
@@ -220,17 +223,48 @@ declare class AbcSong {
     clef: AbcClef;
     keySignature: KeySignature;
 }
-interface NoteGroupInterface {
+type NoteGroupInterface = {
     notes: string;
     lyrics: string;
-}
+};
 
-declare const parse: (abc: string) => AbcSong | undefined;
+/**
+ * Generates an AbcSong object from an ABC notation string.
+ * This function does some extra processing to handle slurs and lyrics properly.
+ * If you do not want this, use `convertStringToAbcTune` directly.
+ *
+ * @param abc
+ */
+declare const parse: (abc: string) => AbcSong;
+/**
+ * Get an info/header field from an ABC notation string.
+ * @param abc
+ * @param field
+ * @param _default
+ */
 declare const getField: (abc: string, field: string, _default?: string) => (string | undefined);
+/**
+ * Extract info/header fields from an ABC notation string into an AbcSong object and return the remaining melody string.
+ * @param abc
+ * @param song
+ */
 declare const extractInfoFields: (abc: string, song: AbcSong) => string;
-declare const extractNotesAndLyrics: (abc: string) => NoteGroupInterface;
-declare const addInfoFieldsToMelody: (song: AbcSong, abc: string) => string;
+/**
+ * Extract notes and lyrics from an ABC notation string as a single line for each.
+ * Note that you must first remove info/header fields before using this function.
+ * @param abc
+ */
+declare const squashNotesAndLyrics: (abc: string) => NoteGroupInterface;
+/**
+ * Converts and validates an ABC notation string into a TuneObject.
+ * @param abc
+ */
 declare const convertStringToAbcTune: (abc: string) => TuneObject;
+/**
+ * Combine multi line lyrics line with a multi line melody into a single ABC notation string.
+ * @param melody
+ * @param lyrics
+ */
 declare const combineMelodyAndLyrics: (melody: string, lyrics: string) => string;
 
 type Verse = {
@@ -253,4 +287,16 @@ 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 };
+/**
+ * Converts an AbcSong object's info fields to ABC notation and merges them with the given melody string.
+ * @param song
+ * @param abc
+ */
+declare const addInfoFieldsToMelody: (song: AbcSong, abc: string) => string;
+/**
+ * Convert an AbcSong object to an ABC notation string.
+ * @param song
+ */
+declare const stringify: (song: AbcSong) => string;
+
+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, generateAbcForVerse, getField, getForVerse, parse, squashNotesAndLyrics, stringify, validate };

package/dist/index.js

@@ -1,51 +1,4 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  AbcSong: () => AbcSong,
-  ValidationError: () => ValidationError,
-  addInfoFieldsToMelody: () => addInfoFieldsToMelody,
-  combineMelodyAndLyrics: () => combineMelodyAndLyrics,
-  convertStringToAbcTune: () => convertStringToAbcTune,
-  extractInfoFields: () => extractInfoFields,
-  extractNotesAndLyrics: () => extractNotesAndLyrics,
-  generateAbcForVerse: () => generateAbcForVerse,
-  getField: () => getField,
-  getForVerse: () => getForVerse,
-  parse: () => parse,
-  validate: () => validate
-});
-module.exports = __toCommonJS(index_exports);
-
-// src/abcTypes.ts
+// src/types.ts
 var AbcSong = class {
   // See also: https://abcnotation.com/wiki/abc:standard:v2.1#information_fields
   area;
@@ -87,8 +40,8 @@ var AbcSong = class {
   };
 };
 
-// src/abc.ts
-var ABCJS = __toESM(require("abcjs"));
+// src/parser.ts
+import * as ABCJS from "abcjs";
 
 // src/validation.ts
 var ValidationError = class extends Error {
@@ -100,15 +53,155 @@ function validate(result, message) {
   throw new ValidationError(message || "Value is not true");
 }
 
-// src/abc.ts
+// src/deparser.ts
+var addInfoFieldsToMelody = (song, abc) => {
+  let result = "";
+  result += song.referenceNumber === void 0 ? "" : "X:" + song.referenceNumber + "\n";
+  result += song.title === void 0 ? "" : "T:" + song.title + "\n";
+  result += song.area === void 0 ? "" : "A:" + song.area + "\n";
+  result += song.book === void 0 ? "" : "B:" + song.book + "\n";
+  result += song.composer === void 0 ? "" : "C:" + song.composer + "\n";
+  result += song.discography === void 0 ? "" : "D:" + song.discography + "\n";
+  result += song.fileUrl === void 0 ? "" : "F:" + song.fileUrl + "\n";
+  result += song.group === void 0 ? "" : "G:" + song.group + "\n";
+  result += song.history === void 0 ? "" : "H:" + song.history + "\n";
+  result += song.instruction === void 0 ? "" : "I:" + song.instruction + "\n";
+  result += song.key === void 0 ? "" : "K:" + song.key + "\n";
+  result += song.unitNoteLength === void 0 ? "" : "L:" + song.unitNoteLength + "\n";
+  result += song.meter === void 0 ? "" : "M:" + song.meter + "\n";
+  result += song.macro === void 0 ? "" : "m:" + song.macro + "\n";
+  result += song.notes === void 0 ? "" : "N:" + song.notes + "\n";
+  result += song.origin === void 0 ? "" : "O:" + song.origin + "\n";
+  result += song.parts === void 0 ? "" : "P:" + song.parts + "\n";
+  result += song.tempo === void 0 ? "" : "Q:" + song.tempo + "\n";
+  result += song.rhythm === void 0 ? "" : "R:" + song.rhythm + "\n";
+  result += song.remark === void 0 ? "" : "r:" + song.remark + "\n";
+  result += song.source === void 0 ? "" : "S:" + song.source + "\n";
+  result += song.symbolLine === void 0 ? "" : "s:" + song.symbolLine + "\n";
+  result += song.userDefined === void 0 ? "" : "U:" + song.userDefined + "\n";
+  result += song.voice === void 0 ? "" : "V:" + song.voice + "\n";
+  result += song.transcription === void 0 ? "" : "Z:" + song.transcription + "\n";
+  return result + abc;
+};
+var durationToString = (duration) => {
+  duration /= 4;
+  if (duration > 3 / 8) return (duration * 4).toString();
+  if (duration == 1 / 4) return "";
+  if (duration == 3 / 8) return "3/2";
+  if (duration == 1 / 8) return "/2";
+  if (duration == 3 / 16) return "3/4";
+  if (duration == 1 / 16) return "/4";
+  if (duration == 3 / 32) return "3/8";
+  if (duration == 1 / 32) return "/8";
+  if (duration == 3 / 64) return "3/16";
+  return "";
+};
+var voiceBarToString = (voice) => {
+  let result = "";
+  switch (voice.type) {
+    case "bar_thin":
+      result += "|";
+      break;
+    case "bar_thin_thick":
+      result += "|]";
+      break;
+    case "bar_thin_thin":
+      result += "||";
+      break;
+    case "bar_thick_thin":
+      result += "[|";
+      break;
+    case "bar_right_repeat":
+      result += ":|";
+      break;
+    case "bar_left_repeat":
+      result += "|:";
+      break;
+    case "bar_dbl_repeat":
+      result += "::";
+      break;
+  }
+  if (voice.startEnding) result += voice.startEnding;
+  return result + " ";
+};
+var voiceNoteToString = (voice, durationMultiplier, isBeam) => {
+  let notes = "";
+  let lyrics = "";
+  const duration = durationToString(voice.duration / durationMultiplier);
+  if (voice.startBeam) isBeam = true;
+  if (voice.endBeam) isBeam = false;
+  voice.chord?.forEach((chord) => {
+    const parsedChordName = chord.name.replaceAll(/♭/g, "b").replaceAll(/♯/g, "#");
+    notes += `"${parsedChordName}"`;
+  });
+  if (voice.pitches && voice.pitches?.length > 1) notes += "[";
+  voice.pitches?.forEach((pitch) => {
+    let note = pitch.name + duration;
+    if (pitch.startSlur) note = "(".repeat(pitch.startSlur.length) + note;
+    if (pitch.endSlur) note += ")".repeat(pitch.endSlur.length);
+    if (pitch.startTie) note += "-";
+    notes += note;
+  });
+  if (voice.pitches && voice.pitches?.length > 1) notes += "]";
+  if (voice.rest) {
+    if (voice.rest.type == "spacer") {
+      notes += "y";
+    } else if (voice.rest.type == "multimeasure") {
+      notes += "Z" + durationToString(voice.duration / 4);
+    } else {
+      notes += "z" + duration;
+    }
+  }
+  if (voice.pitches) {
+    voice.lyric?.forEach((lyric) => {
+      let text = lyric.syllable.replace(/ /g, "~");
+      if (text == "") text = "*";
+      lyrics += text + lyric.divider;
+    });
+  }
+  if (!isBeam) notes += " ";
+  return {
+    notes,
+    lyrics,
+    isBeam
+  };
+};
+var stringify = (song) => {
+  const durationParts = (song.unitNoteLength || "1/8").split("/");
+  const durationMultiplier = durationParts.length > 1 ? +durationParts[0] / +durationParts[1] : +durationParts[0];
+  const melody = song.melody.flatMap((line) => {
+    const notes = [];
+    const lyrics = [];
+    let isBeam = false;
+    line.forEach((voice) => {
+      switch (voice.el_type) {
+        case "bar":
+          notes.push(voiceBarToString(voice));
+          break;
+        case "note":
+          const result2 = voiceNoteToString(voice, durationMultiplier, isBeam);
+          notes.push(result2.notes);
+          lyrics.push(result2.lyrics);
+          isBeam = result2.isBeam;
+          break;
+      }
+    });
+    const result = [notes.join("").trim()];
+    const mergedLyrics = lyrics.join("").trim();
+    if (mergedLyrics.length > 0) {
+      result.push("w: " + mergedLyrics);
+    }
+    return result;
+  }).join("\n");
+  return addInfoFieldsToMelody(song, melody);
+};
+
+// src/parser.ts
 var parse = (abc) => {
   abc = abc.replace(/%.*/g, "").replaceAll(/\n+/g, "\n");
   const song = new AbcSong();
   extractInfoFields(abc, song);
   const tuneObject = convertStringToAbcTune(abc);
-  if (tuneObject === void 0) {
-    return void 0;
-  }
   song.clef = tuneObject.lines[0].staff[0].clef || song.clef;
   song.keySignature = tuneObject.lines[0].staff[0].key || song.keySignature;
   song.melody = tuneObject.lines.map((line) => line.staff[0].voices[0]);
@@ -196,7 +289,7 @@ var extractInfoFields = (abc, song) => {
   song.transcription = getField(abc, "Z");
   return abc.replace(/%.*\n/g, "").replace(/(^|\n) *\t*[ABCDFGHIKLMmNOPQRrSsTUVXZ]:.*/g, "").replace(/\n+/g, "\n").replace(/^\n*/g, "").replace(/\n*$/g, "");
 };
-var extractNotesAndLyrics = (abc) => {
+var squashNotesAndLyrics = (abc) => {
   const notes = [];
   const lyrics = [];
   abc.split("\n").map((it) => it.trim()).forEach((it) => {
@@ -211,41 +304,13 @@ var extractNotesAndLyrics = (abc) => {
     lyrics: lyrics.join(" ")
   };
 };
-var addInfoFieldsToMelody = (song, abc) => {
-  let result = "";
-  result += song.referenceNumber === void 0 ? "" : "X:" + song.referenceNumber + "\n";
-  result += song.title === void 0 ? "" : "T:" + song.title + "\n";
-  result += song.area === void 0 ? "" : "A:" + song.area + "\n";
-  result += song.book === void 0 ? "" : "B:" + song.book + "\n";
-  result += song.composer === void 0 ? "" : "C:" + song.composer + "\n";
-  result += song.discography === void 0 ? "" : "D:" + song.discography + "\n";
-  result += song.fileUrl === void 0 ? "" : "F:" + song.fileUrl + "\n";
-  result += song.group === void 0 ? "" : "G:" + song.group + "\n";
-  result += song.history === void 0 ? "" : "H:" + song.history + "\n";
-  result += song.instruction === void 0 ? "" : "I:" + song.instruction + "\n";
-  result += song.key === void 0 ? "" : "K:" + song.key + "\n";
-  result += song.unitNoteLength === void 0 ? "" : "L:" + song.unitNoteLength + "\n";
-  result += song.meter === void 0 ? "" : "M:" + song.meter + "\n";
-  result += song.macro === void 0 ? "" : "m:" + song.macro + "\n";
-  result += song.notes === void 0 ? "" : "N:" + song.notes + "\n";
-  result += song.origin === void 0 ? "" : "O:" + song.origin + "\n";
-  result += song.parts === void 0 ? "" : "P:" + song.parts + "\n";
-  result += song.tempo === void 0 ? "" : "Q:" + song.tempo + "\n";
-  result += song.rhythm === void 0 ? "" : "R:" + song.rhythm + "\n";
-  result += song.remark === void 0 ? "" : "r:" + song.remark + "\n";
-  result += song.source === void 0 ? "" : "S:" + song.source + "\n";
-  result += song.symbolLine === void 0 ? "" : "s:" + song.symbolLine + "\n";
-  result += song.userDefined === void 0 ? "" : "U:" + song.userDefined + "\n";
-  result += song.voice === void 0 ? "" : "V:" + song.voice + "\n";
-  result += song.transcription === void 0 ? "" : "Z:" + song.transcription + "\n";
-  return result + abc;
-};
 var convertStringToAbcTune = (abc) => {
   const objectArray = ABCJS.parseOnly(abc);
   const object = objectArray;
   validate(object != null, "Tune object may not be null");
   validate(object.length > 0, "Tune object may not be empty");
   validate(object[0].lines != null, "Tune object lines may not be null");
+  object[0].lines = object[0].lines.filter((it) => it.staff);
   validate(object[0].lines.length > 0, "Tune object lines are empty");
   validate(object[0].lines[0].staff != null, "Staffs may not be null");
   validate(object[0].lines[0].staff.length > 0, "Staffs are empty");
@@ -293,18 +358,18 @@ var generateAbcForVerse = (verse, activeMelody) => {
   const melody = getForVerse(activeMelody, verse)?.melody || activeMelody.melody;
   return combineMelodyAndLyrics(melody, verse.abcLyrics || "");
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   AbcSong,
   ValidationError,
   addInfoFieldsToMelody,
   combineMelodyAndLyrics,
   convertStringToAbcTune,
   extractInfoFields,
-  extractNotesAndLyrics,
   generateAbcForVerse,
   getField,
   getForVerse,
   parse,
+  squashNotesAndLyrics,
+  stringify,
   validate
-});
+};

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "@hymnbook/abc",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "description": "",
+  "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "tsup"
+    "test": "node --experimental-vm-modules node_modules/.bin/jest",
+    "build": "tsup",
+    "publish": "npm run test && npm run build && npm publish --access public",
+    "publish-patch": "npm version patch && npm run publish",
+    "publish-minor": "npm version minor && npm run publish",
+    "publish-major": "npm version major && npm run publish"
   },
   "repository": {
     "type": "git",
@@ -23,7 +29,9 @@
   },
   "homepage": "https://github.com/sampie777/hymnbook-abc",
   "devDependencies": {
-    "abcjs": "git+https://github.com/paulrosen/abcjs.git#v6.2.3",
+    "@jest/globals": "^30.2.0",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3"
   },
@@ -33,5 +41,14 @@
     "README.md",
     "package.json",
     "package-lock.json"
-  ]
+  ],
+  "dependencies": {
+    "abcjs": "^6.5.2"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  }
 }

package/src/based.ts

@@ -1,4 +1,4 @@
-import { combineMelodyAndLyrics } from "./abc";
+import { combineMelodyAndLyrics } from "./parser";
 import { AbcMelody, AbcSubMelody, Verse } from "./basedTypes";
 
 

package/src/deparser.ts

@@ -0,0 +1,186 @@
+import { AbcSong, VoiceItemBar, VoiceItemNote } from "./types";
+
+/**
+ * Converts an AbcSong object's info fields to ABC notation and merges them with the given melody string.
+ * @param song
+ * @param abc
+ */
+export const addInfoFieldsToMelody = (song: AbcSong, abc: string): string => {
+  let result = "";
+  // See for following order of fields: https://abcnotation.com/wiki/abc:standard:v2.1#description_of_information_fields
+  result += song.referenceNumber === undefined ? "" : "X:" + song.referenceNumber + "\n";
+  result += song.title === undefined ? "" : "T:" + song.title + "\n";
+  result += song.area === undefined ? "" : "A:" + song.area + "\n";
+  result += song.book === undefined ? "" : "B:" + song.book + "\n";
+  result += song.composer === undefined ? "" : "C:" + song.composer + "\n";
+  result += song.discography === undefined ? "" : "D:" + song.discography + "\n";
+  result += song.fileUrl === undefined ? "" : "F:" + song.fileUrl + "\n";
+  result += song.group === undefined ? "" : "G:" + song.group + "\n";
+  result += song.history === undefined ? "" : "H:" + song.history + "\n";
+  result += song.instruction === undefined ? "" : "I:" + song.instruction + "\n";
+  result += song.key === undefined ? "" : "K:" + song.key + "\n";
+  result += song.unitNoteLength === undefined ? "" : "L:" + song.unitNoteLength + "\n";
+  result += song.meter === undefined ? "" : "M:" + song.meter + "\n";
+  result += song.macro === undefined ? "" : "m:" + song.macro + "\n";
+  result += song.notes === undefined ? "" : "N:" + song.notes + "\n";
+  result += song.origin === undefined ? "" : "O:" + song.origin + "\n";
+  result += song.parts === undefined ? "" : "P:" + song.parts + "\n";
+  result += song.tempo === undefined ? "" : "Q:" + song.tempo + "\n";
+  result += song.rhythm === undefined ? "" : "R:" + song.rhythm + "\n";
+  result += song.remark === undefined ? "" : "r:" + song.remark + "\n";
+  result += song.source === undefined ? "" : "S:" + song.source + "\n";
+  result += song.symbolLine === undefined ? "" : "s:" + song.symbolLine + "\n";
+  result += song.userDefined === undefined ? "" : "U:" + song.userDefined + "\n";
+  result += song.voice === undefined ? "" : "V:" + song.voice + "\n";
+  result += song.transcription === undefined ? "" : "Z:" + song.transcription + "\n";
+  return result + abc;
+};
+
+const durationToString = (duration: number): string => {
+  duration /= 4;
+  if (duration > 3 / 8) return (duration * 4).toString();
+  if (duration == 1 / 4) return "";
+  if (duration == 3 / 8) return "3/2";
+  if (duration == 1 / 8) return "/2";
+  if (duration == 3 / 16) return "3/4";
+  if (duration == 1 / 16) return "/4";
+  if (duration == 3 / 32) return "3/8";
+  if (duration == 1 / 32) return "/8";
+  if (duration == 3 / 64) return "3/16";
+
+  return ""
+}
+
+const voiceBarToString = (voice: VoiceItemBar): string => {
+  let result = "";
+
+  switch (voice.type) {
+    case "bar_thin":
+      result += "|"
+      break;
+    case "bar_thin_thick":
+      result += "|]"
+      break;
+    case "bar_thin_thin":
+      result += "||"
+      break;
+    case "bar_thick_thin":
+      result += "[|"
+      break;
+    case "bar_right_repeat":
+      result += ":|"
+      break;
+    case "bar_left_repeat":
+      result += "|:"
+      break;
+    case "bar_dbl_repeat":
+      result += "::"
+      break;
+  }
+
+  if (voice.startEnding) result += voice.startEnding
+
+  return result + " ";
+};
+
+const voiceNoteToString = (voice: VoiceItemNote, durationMultiplier: number, isBeam: boolean) => {
+  let notes = "";
+  let lyrics = "";
+
+  const duration = durationToString(voice.duration / durationMultiplier);
+
+  if (voice.startBeam) isBeam = true;
+  if (voice.endBeam) isBeam = false;
+
+  /* Process chords */
+  voice.chord?.forEach(chord => {
+    const parsedChordName = chord.name
+      .replaceAll(/♭/g, "b")
+      .replaceAll(/♯/g, "#")
+    notes += `"${parsedChordName}"`;
+  })
+
+  /* Process notes */
+  if (voice.pitches && voice.pitches?.length > 1) notes += "["
+  voice.pitches?.forEach(pitch => {
+    let note = pitch.name + duration;
+
+    if (pitch.startSlur) note = "(".repeat(pitch.startSlur.length) + note;
+    if (pitch.endSlur) note += ")".repeat(pitch.endSlur.length)
+
+    if (pitch.startTie) note += "-";
+
+    notes += note;
+  })
+  if (voice.pitches && voice.pitches?.length > 1) notes += "]"
+
+  /* Process rests */
+  if (voice.rest) {
+    if (voice.rest.type == "spacer") {
+      notes += "y";
+    } else if (voice.rest.type == "multimeasure") {
+      notes += "Z" + durationToString(voice.duration / 4)
+    } else {
+      notes += "z" + duration;
+    }
+  }
+
+  /* Process lyrics */
+  if (voice.pitches) {
+    voice.lyric?.forEach(lyric => {
+      let text = lyric.syllable.replace(/ /g, "~");
+      if (text == "") text = "*";
+      lyrics += text + lyric.divider
+    })
+  }
+
+  if (!isBeam) notes += " ";
+
+  return {
+    notes: notes,
+    lyrics: lyrics,
+    isBeam: isBeam,
+  }
+};
+
+/**
+ * Convert an AbcSong object to an ABC notation string.
+ * @param song
+ */
+export const stringify = (song: AbcSong) => {
+  const durationParts = (song.unitNoteLength || "1/8").split("/");
+  const durationMultiplier = durationParts.length > 1
+    ? +durationParts[0] / +durationParts[1]
+    : +durationParts[0];
+
+  const melody = song.melody.flatMap(line => {
+    const notes: string[] = [];
+    const lyrics: string[] = [];
+    let isBeam = false;
+
+    line.forEach(voice => {
+      switch (voice.el_type) {
+        case "bar":
+          notes.push(voiceBarToString(voice))
+          break;
+        case "note":
+          const result = voiceNoteToString(voice, durationMultiplier, isBeam)
+          notes.push(result.notes)
+          lyrics.push(result.lyrics)
+          isBeam = result.isBeam
+          break;
+      }
+    })
+
+    const result: string[] = [notes.join("").trim()]
+    const mergedLyrics = lyrics.join("").trim()
+    if (mergedLyrics.length > 0) {
+      result.push("w: " + mergedLyrics)
+    }
+
+    return result;
+  })
+    .join("\n")
+
+  return addInfoFieldsToMelody(song, melody);
+};

package/src/index.ts

@@ -1,5 +1,6 @@
-export * from './abcTypes';
-export * from './abc';
+export * from './types';
+export * from './parser';
 export * from './basedTypes';
 export * from './based';
-export * from './validation';
+export * from './validation';
+export * from './deparser';

package/src/{abc.ts → parser.ts}

@@ -8,13 +8,20 @@ import {
   TuneObject,
   VoiceItem,
   VoiceItemNote
-} from "./abcTypes";
+} from "./types";
 import { validate } from "./validation";
+import { addInfoFieldsToMelody } from "./deparser";
 
 // See also https://abcnotation.com/examples
 
-
-export const parse = (abc: string): AbcSong | undefined => {
+/**
+ * Generates an AbcSong object from an ABC notation string.
+ * This function does some extra processing to handle slurs and lyrics properly.
+ * If you do not want this, use `convertStringToAbcTune` directly.
+ *
+ * @param abc
+ */
+export const parse = (abc: string): AbcSong => {
   // Remove comments
   abc = abc
     .replace(/%.*/g, "")
@@ -24,9 +31,6 @@ export const parse = (abc: string): AbcSong | undefined => {
   extractInfoFields(abc, song);
 
   const tuneObject = convertStringToAbcTune(abc);
-  if (tuneObject === undefined) {
-    return undefined;
-  }
 
   // Get the first staff only (thus in case of multiple instrument play, only take the first instrument)
   song.clef = tuneObject.lines!![0].staff!![0].clef || song.clef;
@@ -118,6 +122,12 @@ const processSlursForLine = (line: VoiceItem[]) => {
   });
 };
 
+/**
+ * Get an info/header field from an ABC notation string.
+ * @param abc
+ * @param field
+ * @param _default
+ */
 export const getField = (abc: string, field: string, _default?: string): (string | undefined) => {
   const result = abc.match(new RegExp("(^|\n) *\t*" + field + ":(.*)?"));
   if (result == null || result.length !== 3 || result[2] == null) {
@@ -126,6 +136,11 @@ export const getField = (abc: string, field: string, _default?: string): (string
   return result[2].trim();
 };
 
+/**
+ * Extract info/header fields from an ABC notation string into an AbcSong object and return the remaining melody string.
+ * @param abc
+ * @param song
+ */
 export const extractInfoFields = (abc: string, song: AbcSong): string => {
   song.area = getField(abc, "A");
   song.book = getField(abc, "B");
@@ -152,6 +167,7 @@ export const extractInfoFields = (abc: string, song: AbcSong): string => {
   song.voice = getField(abc, "V");
   song.referenceNumber = getField(abc, "X", "1");
   song.transcription = getField(abc, "Z");
+
   return abc
     .replace(/%.*\n/g, "")
     .replace(/(^|\n) *\t*[ABCDFGHIKLMmNOPQRrSsTUVXZ]:.*/g, "")
@@ -160,7 +176,12 @@ export const extractInfoFields = (abc: string, song: AbcSong): string => {
     .replace(/\n*$/g, "");
 };
 
-export const extractNotesAndLyrics = (abc: string): NoteGroupInterface => {
+/**
+ * Extract notes and lyrics from an ABC notation string as a single line for each.
+ * Note that you must first remove info/header fields before using this function.
+ * @param abc
+ */
+export const squashNotesAndLyrics = (abc: string): NoteGroupInterface => {
   const notes: string[] = [];
   const lyrics: string[] = [];
   abc.split("\n")
@@ -176,40 +197,13 @@ export const extractNotesAndLyrics = (abc: string): NoteGroupInterface => {
   return {
     notes: notes.join(" "),
     lyrics: lyrics.join(" ")
-  } as NoteGroupInterface;
-};
-
-export const addInfoFieldsToMelody = (song: AbcSong, abc: string): string => {
-  let result = "";
-  // See for following order of fields: https://abcnotation.com/wiki/abc:standard:v2.1#description_of_information_fields
-  result += song.referenceNumber === undefined ? "" : "X:" + song.referenceNumber + "\n";
-  result += song.title === undefined ? "" : "T:" + song.title + "\n";
-  result += song.area === undefined ? "" : "A:" + song.area + "\n";
-  result += song.book === undefined ? "" : "B:" + song.book + "\n";
-  result += song.composer === undefined ? "" : "C:" + song.composer + "\n";
-  result += song.discography === undefined ? "" : "D:" + song.discography + "\n";
-  result += song.fileUrl === undefined ? "" : "F:" + song.fileUrl + "\n";
-  result += song.group === undefined ? "" : "G:" + song.group + "\n";
-  result += song.history === undefined ? "" : "H:" + song.history + "\n";
-  result += song.instruction === undefined ? "" : "I:" + song.instruction + "\n";
-  result += song.key === undefined ? "" : "K:" + song.key + "\n";
-  result += song.unitNoteLength === undefined ? "" : "L:" + song.unitNoteLength + "\n";
-  result += song.meter === undefined ? "" : "M:" + song.meter + "\n";
-  result += song.macro === undefined ? "" : "m:" + song.macro + "\n";
-  result += song.notes === undefined ? "" : "N:" + song.notes + "\n";
-  result += song.origin === undefined ? "" : "O:" + song.origin + "\n";
-  result += song.parts === undefined ? "" : "P:" + song.parts + "\n";
-  result += song.tempo === undefined ? "" : "Q:" + song.tempo + "\n";
-  result += song.rhythm === undefined ? "" : "R:" + song.rhythm + "\n";
-  result += song.remark === undefined ? "" : "r:" + song.remark + "\n";
-  result += song.source === undefined ? "" : "S:" + song.source + "\n";
-  result += song.symbolLine === undefined ? "" : "s:" + song.symbolLine + "\n";
-  result += song.userDefined === undefined ? "" : "U:" + song.userDefined + "\n";
-  result += song.voice === undefined ? "" : "V:" + song.voice + "\n";
-  result += song.transcription === undefined ? "" : "Z:" + song.transcription + "\n";
-  return result + abc;
+  };
 };
 
+/**
+ * Converts and validates an ABC notation string into a TuneObject.
+ * @param abc
+ */
 export const convertStringToAbcTune = (abc: string): TuneObject => {
   const objectArray: TuneObjectArray = ABCJS.parseOnly(abc);
   // Convert types
@@ -218,6 +212,9 @@ export const convertStringToAbcTune = (abc: string): TuneObject => {
   validate(object != null, "Tune object may not be null");
   validate(object.length > 0, "Tune object may not be empty");
   validate(object[0].lines != null, "Tune object lines may not be null");
+
+  object[0].lines = object[0].lines.filter(it => it.staff); // Remove empty lines without staff
+
   validate(object[0].lines.length > 0, "Tune object lines are empty");
   validate(object[0].lines[0].staff != null, "Staffs may not be null");
   validate(object[0].lines[0].staff!!.length > 0, "Staffs are empty");
@@ -246,7 +243,11 @@ const processAbcLyrics = (object: Array<TuneObject>) => {
   );
 };
 
-// Match each lyric line with each melody line
+/**
+ * Combine multi line lyrics line with a multi line melody into a single ABC notation string.
+ * @param melody
+ * @param lyrics
+ */
 export const combineMelodyAndLyrics = (melody: string, lyrics: string): string => {
   const song = new AbcSong();
   const rawMelody = extractInfoFields(melody, song);

package/src/{abcTypes.ts → types.ts}

@@ -12,7 +12,7 @@ export type AbcType =
   | "bar_thick_thin"
   | "bar_right_repeat"
   | "bar_left_repeat"
-  | "bar_double_repeat";
+  | "bar_dbl_repeat";
 export type AbcElementType = "note" | "bar";
 export type Clef =
   "treble"
@@ -99,6 +99,7 @@ export interface VoiceItemBar {
   type: AbcType;
   startChar: number;
   endChar: number;
+  startEnding?: string; // Labels the repeat section
 }
 
 export interface NoteProperties {
@@ -107,6 +108,8 @@ export interface NoteProperties {
   lyric?: AbcLyric[];
   chord?: AbcChord[];
   rest?: AbcRest;
+  startBeam?: boolean;
+  endBeam?: boolean;
 }
 
 export interface VoiceItemNote extends NoteProperties {
@@ -308,7 +311,7 @@ export class AbcSong {
   };
 }
 
-export interface NoteGroupInterface {
-  notes: string,
+export type NoteGroupInterface = {
+  notes: string
   lyrics: string
 }