chordsheetjs 6.2.2 → 6.3.0

package/README.md

@@ -1,4 +1,4 @@
-# ChordChartJS [![Code Climate](https://codeclimate.com/github/PraiseCharts/ChordChartJS/badges/gpa.svg)](https://codeclimate.com/github/PraiseCharts/ChordChartJS)
+# ChordSheetJS [![Code Climate](https://codeclimate.com/github/martijnversluis/ChordSheetJS/badges/gpa.svg)](https://codeclimate.com/github/martijnversluis/ChordSheetJS)
 
 A JavaScript library for parsing and formatting chord sheets
 
@@ -11,6 +11,8 @@ A JavaScript library for parsing and formatting chord sheets
 
 ## Installation
 
+### Package managers
+
 `ChordSheetJS` is on npm, to install run:
 
 ```bash
@@ -631,10 +633,13 @@ If not, it returns [INDETERMINATE](#INDETERMINATE)</p>
     * [new Song(metadata)](#new_Song_new)
     * [.bodyLines](#Song+bodyLines) ⇒ <code>Array.&lt;Line&gt;</code>
     * [.bodyParagraphs](#Song+bodyParagraphs) ⇒ [<code>Array.&lt;Paragraph&gt;</code>](#Paragraph)
+    * [.paragraphs](#Song+paragraphs) : [<code>Array.&lt;Paragraph&gt;</code>](#Paragraph)
     * ~~[.metaData](#Song+metaData) ⇒~~
     * [.clone()](#Song+clone) ⇒ [<code>Song</code>](#Song)
     * [.setCapo(capo)](#Song+setCapo) ⇒ [<code>Song</code>](#Song)
     * [.setKey(key)](#Song+setKey) ⇒ [<code>Song</code>](#Song)
+    * [.mapItems(func)](#Song+mapItems) ⇒ [<code>Song</code>](#Song)
+    * [.mapLines(func)](#Song+mapLines) ⇒ [<code>Song</code>](#Song)
 
 <a name="new_Song_new"></a>
 
@@ -662,6 +667,12 @@ if you want to skip the &quot;header lines&quot;: the lines that only contain me
 
 **Kind**: instance property of [<code>Song</code>](#Song)  
 **See**: [bodyLines](bodyLines)  
+<a name="Song+paragraphs"></a>
+
+### song.paragraphs : [<code>Array.&lt;Paragraph&gt;</code>](#Paragraph)
+<p>The [Paragraph](#Paragraph) items of which the song consists</p>
+
+**Kind**: instance property of [<code>Song</code>](#Song)  
 <a name="Song+metaData"></a>
 
 ### ~~song.metaData ⇒~~
@@ -711,6 +722,52 @@ if you want to skip the &quot;header lines&quot;: the lines that only contain me
 | --- | --- | --- |
 | key | <code>string</code> | <p>The new key.</p> |
 
+<a name="Song+mapItems"></a>
+
+### song.mapItems(func) ⇒ [<code>Song</code>](#Song)
+<p>Change the song contents inline. Return a new [Item](Item) to replace it. Return <code>null</code> to remove it.</p>
+
+**Kind**: instance method of [<code>Song</code>](#Song)  
+**Returns**: [<code>Song</code>](#Song) - <p>the changed song</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| func | <code>MapItemsCallback</code> | <p>the callback function</p> |
+
+**Example**  
+```js
+// transpose all chords:
+song.mapItems((item) => {
+  if (item instanceof ChordLyricsPair) {
+    return item.transpose(2, 'D');
+  }
+
+  return item;
+});
+```
+<a name="Song+mapLines"></a>
+
+### song.mapLines(func) ⇒ [<code>Song</code>](#Song)
+<p>Change the song contents inline. Return a new [Line](Line) to replace it. Return <code>null</code> to remove it.</p>
+
+**Kind**: instance method of [<code>Song</code>](#Song)  
+**Returns**: [<code>Song</code>](#Song) - <p>the changed song</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| func | <code>MapLinesCallback</code> | <p>the callback function</p> |
+
+**Example**  
+```js
+// remove lines with only Tags:
+song.mapLines((line) => {
+  if (line.items.every(item => item instanceof Tag)) {
+    return null;
+  }
+
+  return line;
+});
+```
 <a name="Tag"></a>
 
 ## Tag

package/lib/bundle.js

@@ -3388,6 +3388,11 @@ var $26f57998457eb2d4$export$2e2bcd8739ae039 = $26f57998457eb2d4$var$Chord;
     set(properties) {
         return new $d454f4215ba01af2$var$ChordLyricsPair(properties.chords || this.chords, properties.lyrics || this.lyrics);
     }
+    setLyrics(lyrics) {
+        return this.set({
+            lyrics: lyrics
+        });
+    }
     transpose(delta, key) {
         const chordObj = $26f57998457eb2d4$export$2e2bcd8739ae039.parse(this.chords);
         if (chordObj) return this.set({
@@ -3564,6 +3569,11 @@ const $5e9ede69210ec54a$var$translateTagNameAlias = (name)=>{
     set({ value: value  }) {
         return new $5e9ede69210ec54a$var$Tag(this._originalName, value);
     }
+    setValue(value) {
+        return this.set({
+            value: value
+        });
+    }
 }
 var $5e9ede69210ec54a$export$2e2bcd8739ae039 = $5e9ede69210ec54a$var$Tag;
 
@@ -3962,12 +3972,7 @@ var $ce1dd7d0f2cd2369$export$2e2bcd8739ae039 = $ce1dd7d0f2cd2369$var$ParserWarni
    * The {@link Line} items of which the song consists
    * @member {Line[]}
    */ lines = [];
-    /**
-   * The {@link Paragraph} items of which the song consists
-   * @member {Paragraph[]}
-   */ paragraphs = [];
     currentLine = null;
-    currentParagraph = null;
     warnings = [];
     sectionType = $af8d31735c159a26$export$c53d0f541b41b88e;
     currentKey = null;
@@ -4016,37 +4021,35 @@ var $ce1dd7d0f2cd2369$export$2e2bcd8739ae039 = $ce1dd7d0f2cd2369$var$ParserWarni
         this.ensureLine();
         this.currentLine.lyrics(chr);
     }
-    addLine() {
-        this.ensureParagraph();
-        this.flushLine();
-        this.currentLine = $21a34a464e7bc609$export$13215d9ce4923f76(this.lines, $bc411321e9739719$export$2e2bcd8739ae039);
+    addLine(line) {
+        this.currentLine = line || $21a34a464e7bc609$export$13215d9ce4923f76(this.lines, $bc411321e9739719$export$2e2bcd8739ae039);
         this.setCurrentLineType(this.sectionType);
         this.currentLine.transposeKey = this.transposeKey ?? this.currentKey;
         this.currentLine.key = this.currentKey || this.metadata.getSingle($5e9ede69210ec54a$export$7167c830cefcb6b5);
         return this.currentLine;
     }
+    /**
+   * The {@link Paragraph} items of which the song consists
+   * @member {Paragraph[]}
+   */ get paragraphs() {
+        let currentParagraph = new $0c3420c6a3e8a9d7$export$2e2bcd8739ae039();
+        const paragraphs = [
+            currentParagraph
+        ];
+        this.lines.forEach((line)=>{
+            if (line.isEmpty()) {
+                currentParagraph = new $0c3420c6a3e8a9d7$export$2e2bcd8739ae039();
+                paragraphs.push(currentParagraph);
+            } else if (line.hasRenderableItems()) currentParagraph.addLine(line);
+        });
+        return paragraphs;
+    }
     setCurrentLineType(sectionType) {
         this.currentLine.type = sectionType;
     }
-    flushLine() {
-        if (this.currentLine !== null) {
-            if (this.currentLine.isEmpty()) this.addParagraph();
-            else if (this.currentLine.hasRenderableItems()) this.currentParagraph.addLine(this.currentLine);
-        }
-    }
-    finish() {
-        this.flushLine();
-    }
     ensureLine() {
         if (this.currentLine === null) this.addLine();
     }
-    addParagraph() {
-        this.currentParagraph = $21a34a464e7bc609$export$13215d9ce4923f76(this.paragraphs, $0c3420c6a3e8a9d7$export$2e2bcd8739ae039);
-        return this.currentParagraph;
-    }
-    ensureParagraph() {
-        if (this.currentParagraph === null) this.addParagraph();
-    }
     addTag(tagContents) {
         const tag = $5e9ede69210ec54a$export$2e2bcd8739ae039.parse(tagContents);
         if (tag.isMetaTag()) this.setMetadata(tag.name, tag.value);
@@ -4108,7 +4111,8 @@ var $ce1dd7d0f2cd2369$export$2e2bcd8739ae039 = $ce1dd7d0f2cd2369$var$ParserWarni
    * Returns a deep clone of the song
    * @returns {Song} The cloned song
    */ clone() {
-        return this.mapItems(null);
+        return this.mapItems((item)=>item
+        );
     }
     setMetadata(name, value) {
         this.metadata.add(name, value);
@@ -4179,19 +4183,53 @@ var $ce1dd7d0f2cd2369$export$2e2bcd8739ae039 = $ce1dd7d0f2cd2369$var$ParserWarni
         ];
         return clonedSong;
     }
-    mapItems(func) {
+    /**
+   * Change the song contents inline. Return a new {@link Item} to replace it. Return `null` to remove it.
+   * @example
+   * // transpose all chords:
+   * song.mapItems((item) => {
+   *   if (item instanceof ChordLyricsPair) {
+   *     return item.transpose(2, 'D');
+   *   }
+   *
+   *   return item;
+   * });
+   * @param {MapItemsCallback} func the callback function
+   * @returns {Song} the changed song
+   */ mapItems(func) {
         const clonedSong = new $6f653df65dfdf4ef$var$Song();
-        clonedSong.lines = this.lines.map((line)=>line.mapItems(func)
-        );
-        clonedSong.metadata = this.metadata.clone();
+        this.lines.forEach((line)=>{
+            clonedSong.addLine();
+            line.items.forEach((item)=>{
+                const changedItem = func(item);
+                if (changedItem) clonedSong.addItem(changedItem);
+            });
+        });
         return clonedSong;
     }
-    mapLines(func) {
+    /**
+   * Change the song contents inline. Return a new {@link Line} to replace it. Return `null` to remove it.
+   * @example
+   * // remove lines with only Tags:
+   * song.mapLines((line) => {
+   *   if (line.items.every(item => item instanceof Tag)) {
+   *     return null;
+   *   }
+   *
+   *   return line;
+   * });
+   * @param {MapLinesCallback} func the callback function
+   * @returns {Song} the changed song
+   */ mapLines(func) {
         const clonedSong = new $6f653df65dfdf4ef$var$Song();
-        clonedSong.lines = this.lines.map((line)=>func(line.clone())
-        ).filter((line)=>line
-        );
-        clonedSong.metadata = this.metadata.clone();
+        this.lines.forEach((line)=>{
+            const changedLine = func(line);
+            if (changedLine) {
+                clonedSong.addLine();
+                changedLine.items.forEach((item)=>clonedSong.addItem(item)
+                );
+            }
+        });
         return clonedSong;
     }
     updateItem(findCallback, updateCallback, notFoundCallback) {
@@ -4394,7 +4432,6 @@ const $1c14afc274b727b7$var$LINE = 'line';
    * @returns {Song} The deserialized song
    */ deserialize(serializedSong) {
         this.parseAstComponent(serializedSong);
-        this.song.finish();
         return this.song;
     }
     parseAstComponent(astComponent) {
@@ -4528,7 +4565,6 @@ const $c049675f48c823b2$var$CHORD_LINE_REGEX = /^\s*((([A-G])(#|b)?([^/\s]*)(\/(
             this.parseLine(line);
         }
         this.endOfSong();
-        this.song.finish();
         return this.song;
     }
     endOfSong() {}

package/lib/index.js

@@ -3387,6 +3387,11 @@ var $26f57998457eb2d4$export$2e2bcd8739ae039 = $26f57998457eb2d4$var$Chord;
     set(properties) {
         return new $d454f4215ba01af2$var$ChordLyricsPair(properties.chords || this.chords, properties.lyrics || this.lyrics);
     }
+    setLyrics(lyrics) {
+        return this.set({
+            lyrics: lyrics
+        });
+    }
     transpose(delta, key) {
         const chordObj = $26f57998457eb2d4$export$2e2bcd8739ae039.parse(this.chords);
         if (chordObj) return this.set({
@@ -3563,6 +3568,11 @@ const $5e9ede69210ec54a$var$translateTagNameAlias = (name)=>{
     set({ value: value  }) {
         return new $5e9ede69210ec54a$var$Tag(this._originalName, value);
     }
+    setValue(value) {
+        return this.set({
+            value: value
+        });
+    }
 }
 var $5e9ede69210ec54a$export$2e2bcd8739ae039 = $5e9ede69210ec54a$var$Tag;
 
@@ -3961,12 +3971,7 @@ var $ce1dd7d0f2cd2369$export$2e2bcd8739ae039 = $ce1dd7d0f2cd2369$var$ParserWarni
    * The {@link Line} items of which the song consists
    * @member {Line[]}
    */ lines = [];
-    /**
-   * The {@link Paragraph} items of which the song consists
-   * @member {Paragraph[]}
-   */ paragraphs = [];
     currentLine = null;
-    currentParagraph = null;
     warnings = [];
     sectionType = $af8d31735c159a26$export$c53d0f541b41b88e;
     currentKey = null;
@@ -4015,37 +4020,35 @@ var $ce1dd7d0f2cd2369$export$2e2bcd8739ae039 = $ce1dd7d0f2cd2369$var$ParserWarni
         this.ensureLine();
         this.currentLine.lyrics(chr);
     }
-    addLine() {
-        this.ensureParagraph();
-        this.flushLine();
-        this.currentLine = $21a34a464e7bc609$export$13215d9ce4923f76(this.lines, $bc411321e9739719$export$2e2bcd8739ae039);
+    addLine(line) {
+        this.currentLine = line || $21a34a464e7bc609$export$13215d9ce4923f76(this.lines, $bc411321e9739719$export$2e2bcd8739ae039);
         this.setCurrentLineType(this.sectionType);
         this.currentLine.transposeKey = this.transposeKey ?? this.currentKey;
         this.currentLine.key = this.currentKey || this.metadata.getSingle($5e9ede69210ec54a$export$7167c830cefcb6b5);
         return this.currentLine;
     }
+    /**
+   * The {@link Paragraph} items of which the song consists
+   * @member {Paragraph[]}
+   */ get paragraphs() {
+        let currentParagraph = new $0c3420c6a3e8a9d7$export$2e2bcd8739ae039();
+        const paragraphs = [
+            currentParagraph
+        ];
+        this.lines.forEach((line)=>{
+            if (line.isEmpty()) {
+                currentParagraph = new $0c3420c6a3e8a9d7$export$2e2bcd8739ae039();
+                paragraphs.push(currentParagraph);
+            } else if (line.hasRenderableItems()) currentParagraph.addLine(line);
+        });
+        return paragraphs;
+    }
     setCurrentLineType(sectionType) {
         this.currentLine.type = sectionType;
     }
-    flushLine() {
-        if (this.currentLine !== null) {
-            if (this.currentLine.isEmpty()) this.addParagraph();
-            else if (this.currentLine.hasRenderableItems()) this.currentParagraph.addLine(this.currentLine);
-        }
-    }
-    finish() {
-        this.flushLine();
-    }
     ensureLine() {
         if (this.currentLine === null) this.addLine();
     }
-    addParagraph() {
-        this.currentParagraph = $21a34a464e7bc609$export$13215d9ce4923f76(this.paragraphs, $0c3420c6a3e8a9d7$export$2e2bcd8739ae039);
-        return this.currentParagraph;
-    }
-    ensureParagraph() {
-        if (this.currentParagraph === null) this.addParagraph();
-    }
     addTag(tagContents) {
         const tag = $5e9ede69210ec54a$export$2e2bcd8739ae039.parse(tagContents);
         if (tag.isMetaTag()) this.setMetadata(tag.name, tag.value);
@@ -4107,7 +4110,8 @@ var $ce1dd7d0f2cd2369$export$2e2bcd8739ae039 = $ce1dd7d0f2cd2369$var$ParserWarni
    * Returns a deep clone of the song
    * @returns {Song} The cloned song
    */ clone() {
-        return this.mapItems(null);
+        return this.mapItems((item)=>item
+        );
     }
     setMetadata(name, value) {
         this.metadata.add(name, value);
@@ -4178,19 +4182,53 @@ var $ce1dd7d0f2cd2369$export$2e2bcd8739ae039 = $ce1dd7d0f2cd2369$var$ParserWarni
         ];
         return clonedSong;
     }
-    mapItems(func) {
+    /**
+   * Change the song contents inline. Return a new {@link Item} to replace it. Return `null` to remove it.
+   * @example
+   * // transpose all chords:
+   * song.mapItems((item) => {
+   *   if (item instanceof ChordLyricsPair) {
+   *     return item.transpose(2, 'D');
+   *   }
+   *
+   *   return item;
+   * });
+   * @param {MapItemsCallback} func the callback function
+   * @returns {Song} the changed song
+   */ mapItems(func) {
         const clonedSong = new $6f653df65dfdf4ef$var$Song();
-        clonedSong.lines = this.lines.map((line)=>line.mapItems(func)
-        );
-        clonedSong.metadata = this.metadata.clone();
+        this.lines.forEach((line)=>{
+            clonedSong.addLine();
+            line.items.forEach((item)=>{
+                const changedItem = func(item);
+                if (changedItem) clonedSong.addItem(changedItem);
+            });
+        });
         return clonedSong;
     }
-    mapLines(func) {
+    /**
+   * Change the song contents inline. Return a new {@link Line} to replace it. Return `null` to remove it.
+   * @example
+   * // remove lines with only Tags:
+   * song.mapLines((line) => {
+   *   if (line.items.every(item => item instanceof Tag)) {
+   *     return null;
+   *   }
+   *
+   *   return line;
+   * });
+   * @param {MapLinesCallback} func the callback function
+   * @returns {Song} the changed song
+   */ mapLines(func) {
         const clonedSong = new $6f653df65dfdf4ef$var$Song();
-        clonedSong.lines = this.lines.map((line)=>func(line.clone())
-        ).filter((line)=>line
-        );
-        clonedSong.metadata = this.metadata.clone();
+        this.lines.forEach((line)=>{
+            const changedLine = func(line);
+            if (changedLine) {
+                clonedSong.addLine();
+                changedLine.items.forEach((item)=>clonedSong.addItem(item)
+                );
+            }
+        });
         return clonedSong;
     }
     updateItem(findCallback, updateCallback, notFoundCallback) {
@@ -4393,7 +4431,6 @@ const $1c14afc274b727b7$var$LINE = 'line';
    * @returns {Song} The deserialized song
    */ deserialize(serializedSong) {
         this.parseAstComponent(serializedSong);
-        this.song.finish();
         return this.song;
     }
     parseAstComponent(astComponent) {
@@ -4527,7 +4564,6 @@ const $c049675f48c823b2$var$CHORD_LINE_REGEX = /^\s*((([A-G])(#|b)?([^/\s]*)(\/(
             this.parseLine(line);
         }
         this.endOfSong();
-        this.song.finish();
         return this.song;
     }
     endOfSong() {}