chordsheetjs 15.2.1 → 15.3.1

package/lib/index.js

@@ -5607,6 +5607,7 @@ const $287d3e472e1fbd90$export$82f9bd327a40ea54 = {
     key: null,
     metadata: $287d3e472e1fbd90$export$a014e67b549cbef4,
     normalizeChords: true,
+    normalizeChordSuffix: true,
     useUnicodeModifiers: false,
     user: null
 };
@@ -6373,6 +6374,9 @@ const $fe1d3ba9df1ecad5$export$693785c2cb536a68 = (formatterType, specificDefaul
    * @param {boolean} [configuration.useUnicodeModifiers=false] Whether or not to use unicode flat and sharp
    * symbols.
    * @param {boolean} [configuration.normalizeChords=true] Whether or not to automatically normalize chords
+   * @param {boolean} [configuration.normalizeChordSuffix=true] Whether to normalize chord suffixes (e.g.
+   * `sus2` to `2`, `maj7` to `ma7`). Only takes effect when `normalizeChords` is `true`. Defaults to `false`
+   * for {@link ChordProFormatter} so ChordPro round-trips preserve the user's suffix variant.
    */ constructor(configuration = {}){
         const defaultConfig = this.getDefaultConfiguration();
         this.configuration = (0, $28a2fcb6fb95a147$export$5d86b86a654a7039)(defaultConfig, configuration);
@@ -6524,9 +6528,16 @@ class $15f1d40e3d1ed3a0$var$Ternary extends (0, $8e2590a06c021dbf$export$2e2bcd8
 var $15f1d40e3d1ed3a0$export$2e2bcd8739ae039 = $15f1d40e3d1ed3a0$var$Ternary;
 
 
+
 /**
  * Formats a song into a ChordPro chord sheet
  */ class $244a67400187e14e$var$ChordProFormatter extends (0, $ed0d9ddbbe7224cd$export$2e2bcd8739ae039) {
+    getDefaultConfiguration() {
+        return {
+            ...(0, $fe1d3ba9df1ecad5$export$cb4529290f33d264)(),
+            normalizeChordSuffix: false
+        };
+    }
     /**
    * Formats a song into a ChordPro chord sheet.
    * @param {Song} song The song to be formatted
@@ -6652,7 +6663,9 @@ var $15f1d40e3d1ed3a0$export$2e2bcd8739ae039 = $15f1d40e3d1ed3a0$var$Ternary;
         if (chordLyricsPair.chords) {
             const chordObj = chordLyricsPair.chord;
             if (!chordObj) return `[${chordLyricsPair.chords}]`;
-            const finalChord = this.configuration.normalizeChords ? chordObj.normalize() : chordObj;
+            const finalChord = this.configuration.normalizeChords ? chordObj.normalize(null, {
+                normalizeSuffix: this.configuration.normalizeChordSuffix
+            }) : chordObj;
             return `[${finalChord}]`;
         }
         if (chordLyricsPair.annotation) return `[*${chordLyricsPair.annotation}]`;
@@ -7620,6 +7633,7 @@ const $e02a17f5a26edf19$var$defaultConstructorOptions = {
     contextKey: null,
     decapo: false,
     normalizeChords: true,
+    normalizeChordSuffix: true,
     renderKey: null,
     songKey: null,
     style: null,
@@ -7635,6 +7649,7 @@ class $e02a17f5a26edf19$var$ChordRenderer {
         this.capo = config.decapo ? config.capo : 0;
         this.contextKey = config.contextKey;
         this.normalizeChords = config.normalizeChords;
+        this.normalizeChordSuffix = config.normalizeChordSuffix;
         this.renderKey = config.renderKey;
         this.songKey = config.songKey;
         this.style = config.style;
@@ -7647,7 +7662,9 @@ class $e02a17f5a26edf19$var$ChordRenderer {
         return (0, $28a2fcb6fb95a147$export$79570e60478bce41)(chord, [
             (c)=>c.transpose(this.effectiveTransposeDistance),
             (c)=>this.accidental ? c.useAccidental(this.accidental) : c,
-            (c)=>this.normalizeChords ? c.normalize(this.effectiveKey) : c,
+            (c)=>this.normalizeChords ? c.normalize(this.effectiveKey, {
+                    normalizeSuffix: this.normalizeChordSuffix
+                }) : c,
             (c)=>this.changeChordType(c)
         ]).toString({
             useUnicodeModifier: this.useUnicodeModifier
@@ -8047,13 +8064,38 @@ function $2ce1086ce25c9ac0$export$fd31a53e6281557e(transposeKey, songKey) {
     if (/^\d+$/.test(transposeKey)) return parseInt(transposeKey, 10);
     return (0, $c2d6ab25ad00308f$export$2e2bcd8739ae039).distance(songKey, transposeKey);
 }
-function $2ce1086ce25c9ac0$export$596ec52955da9472(chordString, line, song, { renderKey: renderKey = null, useUnicodeModifier: useUnicodeModifier = false, normalizeChords: normalizeChords = true, decapo: decapo = false } = {}) {
+/**
+ * Renders a chord in the context of a line and song and taking into account some options
+ * @param chordString The chord to render
+ * @param line The line the chord is in
+ * @param song The song the line is in
+ * @param renderKey The key to render the chord in. If not provided, the line key will be used,
+ * or the song key if the line key is not provided.
+ * @param useUnicodeModifier Whether to use unicode modifiers ('\u266f'/'\u266d') or plain text ('#'/'b').
+ * Default `false`.
+ * @param normalizeChords Whether to normalize the chord to the key (default `true`)
+ * @param normalizeChordSuffix Whether to normalize the chord suffix (e.g. `sus2` to `2`, `maj7` to `ma7`).
+ * Only takes effect when `normalizeChords` is `true`. Default `true`.
+ * @param decapo Whether to transpose all chords to eliminate the capo (default `false`)
+ */ const $2ce1086ce25c9ac0$var$renderChordDefaults = {
+    renderKey: null,
+    useUnicodeModifier: false,
+    normalizeChords: true,
+    normalizeChordSuffix: true,
+    decapo: false
+};
+function $2ce1086ce25c9ac0$export$596ec52955da9472(chordString, line, song, options = {}) {
+    const { renderKey: renderKey, useUnicodeModifier: useUnicodeModifier, normalizeChords: normalizeChords, normalizeChordSuffix: normalizeChordSuffix, decapo: decapo } = {
+        ...$2ce1086ce25c9ac0$var$renderChordDefaults,
+        ...options
+    };
     const capoString = song.metadata.getSingle((0, $d21c5c7a462f3c34$export$866f445d49bad88e));
     return new (0, $e02a17f5a26edf19$export$2e2bcd8739ae039)({
         capo: capoString ? parseInt(capoString, 10) : 0,
         contextKey: (0, $c2d6ab25ad00308f$export$2e2bcd8739ae039).wrap(line.key || song.key),
         decapo: decapo,
         normalizeChords: normalizeChords,
+        normalizeChordSuffix: normalizeChordSuffix,
         renderKey: renderKey,
         songKey: (0, $c2d6ab25ad00308f$export$2e2bcd8739ae039).wrap(song.key),
         style: song.metadata.getSingle((0, $d21c5c7a462f3c34$export$d8cbdf44b1f66df1)),
@@ -13989,6 +14031,7 @@ var $f9c5006b26957916$export$2e2bcd8739ae039 = {
         return (0, $2ce1086ce25c9ac0$export$596ec52955da9472)(item.chords, line, this.song, {
             renderKey: this.configuration.key,
             normalizeChords: this.configuration.normalizeChords,
+            normalizeChordSuffix: this.configuration.normalizeChordSuffix,
             decapo: this.configuration.decapo
         });
     }
@@ -26534,6 +26577,7 @@ var $1408adfd7317f0b6$export$2e2bcd8739ae039 = ({ configuration: configuration,
                                     renderKey: key,
                                     useUnicodeModifier: configuration.useUnicodeModifiers,
                                     normalizeChords: configuration.normalizeChords,
+                                    normalizeChordSuffix: configuration.normalizeChordSuffix,
                                     decapo: configuration.decapo
                                 })}
                         </div>
@@ -26733,6 +26777,7 @@ var $396f7048979e89c9$export$2e2bcd8739ae039 = ({ configuration: configuration,
                                             renderKey: key,
                                             useUnicodeModifier: configuration.useUnicodeModifiers,
                                             normalizeChords: configuration.normalizeChords,
+                                            normalizeChordSuffix: configuration.normalizeChordSuffix,
                                             decapo: configuration.decapo
                                         })}</td>
                           `;
@@ -27661,6 +27706,7 @@ var $bdd8c6196670168a$export$2e2bcd8739ae039 = $bdd8c6196670168a$var$Condition;
             renderKey: this.configuration.key,
             useUnicodeModifier: this.configuration.useUnicodeModifiers,
             normalizeChords: this.configuration.normalizeChords,
+            normalizeChordSuffix: this.configuration.normalizeChordSuffix,
             decapo: this.configuration.decapo
         });
         return chords;
@@ -28789,6 +28835,7 @@ class $9c53a1d7fff20a4a$export$e6ce86b8bc39728b {
             renderKey: null,
             useUnicodeModifier: this.config.useUnicodeModifiers,
             normalizeChords: this.config.normalizeChords,
+            normalizeChordSuffix: this.config.normalizeChordSuffix,
             decapo: this.config.decapo
         });
     }
@@ -29865,6 +29912,7 @@ class $7fa32b9e3992eddb$export$12b762d1038ddc6b {
             linePadding: this.configuration.layout.sections.global.linePadding,
             useUnicodeModifiers: this.configuration.useUnicodeModifiers,
             normalizeChords: this.configuration.normalizeChords,
+            normalizeChordSuffix: this.configuration.normalizeChordSuffix,
             // Column and page layout information
             minY: dimensions.minY,
             columnWidth: dimensions.columnWidth,
@@ -30130,7 +30178,7 @@ const $a5a21ced491ea51f$var$endSectionTags = {
 var $a5a21ced491ea51f$export$2e2bcd8739ae039 = $a5a21ced491ea51f$var$UltimateGuitarParser;
 
 
-var $ae92e002ce14f11a$export$2e2bcd8739ae039 = '15.2.1';
+var $ae92e002ce14f11a$export$2e2bcd8739ae039 = '15.3.1';