chordsheetjs 15.4.0 → 15.5.0

package/lib/pdf/main.d.ts

@@ -35,14 +35,16 @@ interface PdfDoc {
 type PdfConstructor = new (options?: jsPDFOptions) => PdfDoc;
 type ParagraphType = 'abc' | 'bridge' | 'chorus' | 'grid' | 'indeterminate' | 'ly' | 'none' | 'svg' | 'tab' | 'textblock' | 'verse' | 'part' | string;
 type Accidental = '#' | 'b';
-type NoAccidental = 'NM';
-type AccidentalMaybe = Accidental | NoAccidental;
 type ChordType = 'symbol' | 'solfege' | 'numeric' | 'numeral';
 type FretNumber = number;
 type OpenFret = 0;
 type NonSoundingString = '-1' | 'N' | 'x';
 type Fret = FretNumber | OpenFret | NonSoundingString;
+type Notation = 'german';
 type ContentType = 'tab' | 'abc' | 'ly' | 'svg' | 'grid' | 'textblock';
+interface ChordParseOptions {
+    notation?: Notation | null;
+}
 interface ChordProperties {
     root?: Key | null;
     suffix?: string | null;
@@ -63,6 +65,7 @@ interface ChordConstructorOptions {
     bass?: Key | null;
     chordType?: ChordType | null;
     optional?: boolean;
+    notation?: Notation | null;
 }
 /**
  * Represents a Chord, consisting of a root, suffix (quality) and bass
@@ -78,10 +81,14 @@ declare class Chord implements ChordProperties {
      * Tries to parse a chord string into a chord
      * Any leading or trailing whitespace is removed first, so a chord like `  \n  E/G# \r ` is valid.
      * @param chordString the chord string, eg `Esus4/G#` or `1sus4/#3`.
+     * @param {ChordParseOptions} [options] parse options
+     * @param {Notation|null} [options.notation] when `'german'`, `B` is interpreted as B-flat (grade 10)
+     * and `H` as B natural (grade 11), and output renders accordingly. Defaults to English semantics where
+     * `B` is B natural and `H` is accepted as an alias for it.
      * @returns {Chord|null}
      */
-    static parse(chordString: string): Chord | null;
-    static parseOrFail(chordString: string): Chord;
+    static parse(chordString: string, options?: ChordParseOptions): Chord | null;
+    static parseOrFail(chordString: string, options?: ChordParseOptions): Chord;
     /**
      * Returns a deep copy of the chord
      * @returns {Chord}
@@ -823,6 +830,7 @@ interface KeyProperties {
     referenceKeyMode?: string | null;
     preferredAccidental?: Accidental | null;
     explicitAccidental?: boolean;
+    preferredNotation?: Notation | null;
 }
 interface ConstructorOptions {
     grade?: number | null;
@@ -835,6 +843,7 @@ interface ConstructorOptions {
     originalKeyString?: string | null;
     preferredAccidental: Accidental | null;
     explicitAccidental?: boolean;
+    preferredNotation?: Notation | null;
 }
 /**
  * Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral).
@@ -859,19 +868,20 @@ declare class Key implements KeyProperties {
     originalKeyString: string | null;
     preferredAccidental: Accidental | null;
     explicitAccidental: boolean;
+    preferredNotation: Notation | null;
     static parse(keyString: string | null): null | Key;
     static parseAsType(trimmed: string, keyType: ChordType): Key | null;
-    static resolve({ key, keyType, minor, accidental, }: {
+    static resolve({ key, keyType, minor, accidental, preferredNotation, }: {
         key: string | number;
         keyType: ChordType;
         minor: string | boolean;
         accidental: Accidental | null;
+        preferredNotation?: Notation | null;
     }): Key | null;
     static getNumberFromKey(keyString: string, keyType: ChordType): number;
     static keyWithAccidental(key: string, accidental: Accidental | null, type: ChordType): string;
     /** @deprecated Use keyWithAccidental instead */
     static keyWithModifier(key: string, accidental: Accidental | null, type: ChordType): string;
-    static toGrade(key: string, accidental: AccidentalMaybe, type: ChordType, isMinor: boolean): number | null;
     static isMinor(key: string, keyType: ChordType, minor: string | undefined | boolean): boolean;
     static parseOrFail(keyString: string | null): Key;
     static wrap(keyStringOrObject: Key | string | null): Key | null;
@@ -884,7 +894,7 @@ declare class Key implements KeyProperties {
      * @return {number} the distance in semitones
      */
     static distance(oneKey: Key | string, otherKey: Key | string): number;
-    constructor({ grade, number, minor, type, accidental, referenceKeyGrade, referenceKeyMode, originalKeyString, preferredAccidental, explicitAccidental, }: ConstructorOptions);
+    constructor({ grade, number, minor, type, accidental, referenceKeyGrade, referenceKeyMode, originalKeyString, preferredAccidental, explicitAccidental, preferredNotation, }: ConstructorOptions);
     distanceTo(otherKey: Key | string): number;
     get effectiveGrade(): number;
     isMinor(): boolean;