chordsheetjs 14.6.1 → 15.0.0

package/lib/pdf/chord_sheet/song_mapper.d.ts

@@ -0,0 +1,15 @@
+import Item from './item';
+import Song from './song';
+export type MapItemsCallback = (_item: Item) => Item | Item[] | null;
+declare class SongMapper {
+    private song;
+    private clonedSong;
+    private builder;
+    private addedLine;
+    constructor(song: Song);
+    mapItems(func: MapItemsCallback): Song;
+    private mapLineItems;
+    private mapItem;
+    ensureLine(): void;
+}
+export default SongMapper;

package/lib/pdf/chord_sheet/standard_metadata_providers.d.ts

@@ -0,0 +1,5 @@
+import Configuration from '../formatter/configuration';
+type Provider = () => string | null;
+export declare function staticProviders(): Map<string, Provider>;
+export declare function configurationProviders(configuration: Configuration): Map<string, Provider>;
+export {};

package/lib/pdf/chord_sheet/tag.d.ts

@@ -0,0 +1,104 @@
+import AstComponent from './ast_component';
+import ChordDefinition from '../chord_definition/chord_definition';
+import TraceInfo from './trace_info';
+export declare const META_TAGS: string[];
+export declare const READ_ONLY_TAGS: string[];
+export declare function isReadonlyTag(tagName: string): boolean;
+/**
+ * Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-directives/
+ */
+declare class Tag extends AstComponent {
+    _isMetaTag: boolean;
+    _originalName: string;
+    _name: string;
+    _value: string;
+    chordDefinition?: ChordDefinition;
+    selector: string | null;
+    isNegated: boolean;
+    /**
+     * The tag attributes. For example, section related tags can have a label:
+     * `{start_of_verse: label="Verse 1"}`
+     * @type {Record<string, string>}
+     */
+    attributes: Record<string, string>;
+    constructor(name: string, value?: string | null, traceInfo?: TraceInfo | null, attributes?: Record<string, string>, selector?: string | null, isNegated?: boolean);
+    private parseNameValue;
+    private parseMetaTag;
+    static parse(tag: string | Tag): Tag | null;
+    static parseWithRegex(tag: string, regex: RegExp): Tag | null;
+    static parseOrFail(tag: string | Tag): Tag;
+    get label(): string;
+    isSectionDelimiter(): boolean;
+    isSectionStart(): boolean;
+    isSectionEnd(): boolean;
+    isInlineFontTag(): boolean;
+    /**
+     * Checks whether the tag is a comment tag ({comment} or {c}).
+     */
+    isComment(): boolean;
+    /**
+     * Checks whether the tag is an image tag ({image}).
+     */
+    isImage(): boolean;
+    set name(name: string);
+    /**
+     * The tag full name. When the original tag used the short name, `name` will return the full name.
+     * @member
+     * @type {string}
+     */
+    get name(): string;
+    /**
+     * The original tag name that was used to construct the tag.
+     * @member
+     * @type {string}
+     */
+    get originalName(): string;
+    set value(value: string);
+    /**
+     * The tag value
+     * @member
+     * @type {string}
+     */
+    get value(): string;
+    /**
+     * Checks whether the tag value is a non-empty string.
+     * @returns {boolean}
+     */
+    hasValue(): boolean;
+    hasAttributes(): boolean;
+    hasLabel(): boolean;
+    /**
+     * Checks whether the tag is usually rendered inline. It currently only applies to comment tags.
+     * @returns {boolean}
+     */
+    isRenderable(): boolean;
+    /**
+     * Check whether this tag's label (if any) should be rendered, as applicable to tags like
+     * `start_of_verse` and `start_of_chorus`.
+     * See https://chordpro.org/chordpro/directives-env_chorus/, https://chordpro.org/chordpro/directives-env_verse/,
+     * https://chordpro.org/chordpro/directives-env_bridge/, https://chordpro.org/chordpro/directives-env_tab/
+     */
+    hasRenderableLabel(): boolean;
+    /**
+     * Checks whether the tag is a standard meta tag, a custom meta directive (`{x_some_name}`)
+     * or a non-standard meta tag (`{meta: name value}`)
+     * @returns {boolean}
+     */
+    isMetaTag(): boolean;
+    /**
+     * Checks whether this tag is a standard meta tag or a custom meta directive (`{x_some_name}`)
+     * @returns {boolean}
+     */
+    isStandardOrCustomMetaTag(): boolean;
+    /**
+     * Returns a clone of the tag.
+     * @returns {Tag} The cloned tag
+     */
+    clone(): Tag;
+    toString(): string;
+    set({ value }: {
+        value: string;
+    }): Tag;
+    setAttribute(name: string, value: string): Tag;
+}
+export default Tag;

package/lib/pdf/chord_sheet/tag_interpreter.d.ts

@@ -0,0 +1,14 @@
+declare class TagInterpreter {
+    tagName: string;
+    tagValue: string;
+    static interpret(tagName: string, tagValue: string): [string | null, string | null];
+    constructor(tagName: string, tagValue: string);
+    interpret(): [string | null, string | null];
+    startOfPart(): [string, string] | null;
+    endOfPart(): [string, string] | null;
+    sectionStart(): [string, string] | null;
+    sectionEnd(): [string, string] | null;
+    startOfSection(): [string, string] | null;
+    endOfSection(): [string, string] | null;
+}
+export default TagInterpreter;

package/lib/pdf/chord_sheet/tags.d.ts

@@ -0,0 +1,259 @@
+/**
+ * Album meta directive. See https://www.chordpro.org/chordpro/directives-album/
+ * @type {string}
+ */
+export declare const ALBUM = "album";
+/**
+ * Arranger meta directive. See https://chordpro.org/chordpro/directives-arranger/
+ * @type {string}
+ */
+export declare const ARRANGER = "arranger";
+/**
+ * Artist meta directive. See https://www.chordpro.org/chordpro/directives-artist/
+ * @type {string}
+ */
+export declare const ARTIST = "artist";
+/**
+ * Capo meta directive. See https://www.chordpro.org/chordpro/directives-capo/
+ * @type {string}
+ */
+export declare const CAPO = "capo";
+/**
+ * Comment directive. See https://www.chordpro.org/chordpro/directives-comment/
+ * @type {string}
+ */
+export declare const COMMENT = "comment";
+/**
+ * Composer meta directive. See https://www.chordpro.org/chordpro/directives-composer/
+ * @type {string}
+ */
+export declare const COMPOSER = "composer";
+/**
+ * Copyright meta directive. See https://www.chordpro.org/chordpro/directives-copyright/
+ * @type {string}
+ */
+export declare const COPYRIGHT = "copyright";
+/**
+ * Duration meta directive. See https://www.chordpro.org/chordpro/directives-duration/
+ * @type {string}
+ */
+export declare const DURATION = "duration";
+/**
+ * Image directive. See https://www.chordpro.org/chordpro/directives-image/
+ * @type {string}
+ */
+export declare const IMAGE = "image";
+/**
+ * End of ABC music notation section See https://chordpro.org/chordpro/directives-env_abc/
+ * @type {string}
+ */
+export declare const END_OF_ABC = "end_of_abc";
+/**
+ * End of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/
+ * @type {string}
+ */
+export declare const END_OF_BRIDGE = "end_of_bridge";
+/**
+ * End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/
+ * @type {string}
+ */
+export declare const END_OF_CHORUS = "end_of_chorus";
+/**
+ * End of grid directive. See https://www.chordpro.org/chordpro/directives-env_grid/
+ * @type {string}
+ */
+export declare const END_OF_GRID = "end_of_grid";
+/**
+ * End of Lilypond music notation section See https://chordpro.org/chordpro/directives-env_ly/
+ * @type {string}
+ */
+export declare const END_OF_LY = "end_of_ly";
+/**
+ * End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/
+ * @type {string}
+ */
+export declare const END_OF_TAB = "end_of_tab";
+/**
+ * End of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/
+ * @type {string}
+ */
+export declare const END_OF_VERSE = "end_of_verse";
+/**
+ * End of part directive.
+ * @type {string}
+ */
+export declare const END_OF_PART = "end_of_part";
+/**
+ * Key meta directive. See https://www.chordpro.org/chordpro/directives-key/
+ * @type {string}
+ */
+export declare const KEY = "key";
+/**
+ * _Key meta directive. Reflects the key as transposed by the capo value
+ * See https://www.chordpro.org/chordpro/directives-key/
+ * @type {string}
+ */
+export declare const _KEY = "_key";
+/**
+ * Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyricist/
+ * @type {string}
+ */
+export declare const LYRICIST = "lyricist";
+/**
+ * Sorttitle meta directive. See https://chordpro.org/chordpro/directives-sorttitle/
+ * @type {string}
+ */
+export declare const SORTTITLE = "sorttitle";
+/**
+ * Start of ABC music notation section See https://chordpro.org/chordpro/directives-env_abc/
+ * @type {string}
+ */
+export declare const START_OF_ABC = "start_of_abc";
+/**
+ * Start of bridge directive. See https://chordpro.org/chordpro/directives-env_bridge/
+ * @type {string}
+ */
+export declare const START_OF_BRIDGE = "start_of_bridge";
+/**
+ * Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/
+ * @type {string}
+ */
+export declare const START_OF_CHORUS = "start_of_chorus";
+/**
+ * Start of grid directive. See https://www.chordpro.org/chordpro/directives-env_grid/
+ * @type {string}
+ */
+export declare const START_OF_GRID = "start_of_grid";
+/**
+ * Start of Lilypond music notation section See https://chordpro.org/chordpro/directives-env_ly/
+ * @type {string}
+ */
+export declare const START_OF_LY = "start_of_ly";
+/**
+ * Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/
+ * @type {string}
+ */
+export declare const START_OF_TAB = "start_of_tab";
+/**
+ * Start of SVG section. See https://www.chordpro.org/chordpro/directives-env_svg/
+ * @type {string}
+ */
+export declare const START_OF_SVG = "start_of_svg";
+/**
+ * End of SVG section. See https://www.chordpro.org/chordpro/directives-env_svg/
+ * @type {string}
+ */
+export declare const END_OF_SVG = "end_of_svg";
+/**
+ * Start of textblock directive. See https://chordpro.org/chordpro/directives-env_textblock/
+ * @type {string}
+ */
+export declare const START_OF_TEXTBLOCK = "start_of_textblock";
+/**
+ * End of textblock directive. See https://chordpro.org/chordpro/directives-env_textblock/
+ * @type {string}
+ */
+export declare const END_OF_TEXTBLOCK = "end_of_textblock";
+/**
+ * Start of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/
+ * @type {string}
+ */
+export declare const START_OF_VERSE = "start_of_verse";
+/**
+ * Start of part
+ * @type {string}
+ */
+export declare const START_OF_PART = "start_of_part";
+/**
+ * Subtitle meta directive. See https://www.chordpro.org/chordpro/directives-subtitle/
+ * @type {string}
+ */
+export declare const SUBTITLE = "subtitle";
+/**
+ * Tempo meta directive. See https://www.chordpro.org/chordpro/directives-tempo/
+ * @type {string}
+ */
+export declare const TEMPO = "tempo";
+/**
+ * Time meta directive. See https://www.chordpro.org/chordpro/directives-time/
+ * @type {string}
+ */
+export declare const TIME = "time";
+/**
+ * Title meta directive. See https://www.chordpro.org/chordpro/directives-title/
+ * @type {string}
+ */
+export declare const TITLE = "title";
+/**
+ * Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/
+ * @type {string}
+ */
+export declare const TRANSPOSE = "transpose";
+/**
+ * New Key meta directive. See: https://github.com/BetterMusic/ChordSheetJS/issues/53
+ * @type {string}
+ */
+export declare const NEW_KEY = "new_key";
+/**
+ * Year meta directive. See https://www.chordpro.org/chordpro/directives-year/
+ * @type {string}
+ */
+export declare const YEAR = "year";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/
+ * @type {string}
+ */
+export declare const CHORDFONT = "chordfont";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/
+ * @type {string}
+ */
+export declare const CHORDSIZE = "chordsize";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_chord_legacy/
+ * @type {string}
+ */
+export declare const CHORDCOLOUR = "chordcolour";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/
+ * @type {string}
+ */
+export declare const TEXTFONT = "textfont";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/
+ * @type {string}
+ */
+export declare const TEXTSIZE = "textsize";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_text_legacy/
+ * @type {string}
+ */
+export declare const TEXTCOLOUR = "textcolour";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/
+ * @type {string}
+ */
+export declare const TITLEFONT = "titlefont";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/
+ * @type {string}
+ */
+export declare const TITLESIZE = "titlesize";
+/**
+ * Chordfont directive. See https://www.chordpro.org/chordpro/directives-props_title_legacy/
+ * @type {string}
+ */
+export declare const TITLECOLOUR = "titlecolour";
+/**
+ * Chorus directive. Support repeating an earlier defined section.
+ * See https://www.chordpro.org/chordpro/directives-env_chorus/
+ * @type {string}
+ */
+export declare const CHORUS = "chorus";
+/**
+ * Chord type directive. Determines the type of chords used in the rendered chord sheet.
+ * Possible values are 'solfege', 'symbol', 'numeral' and 'number'
+ * @see https://github.com/bettermusic/ChordSheetJS/issues/352
+ * @type {string}
+ */
+export declare const CHORD_STYLE = "chord_style";

package/lib/pdf/chord_sheet/trace_info.d.ts

@@ -0,0 +1,6 @@
+interface TraceInfo {
+    line?: number | null;
+    column?: number | null;
+    offset?: number | null;
+}
+export default TraceInfo;

package/lib/pdf/chord_sheet_serializer.d.ts

@@ -0,0 +1,49 @@
+import AstType from './chord_sheet/ast_type';
+import ChordDefinition from './chord_definition/chord_definition';
+import ChordLyricsPair from './chord_sheet/chord_lyrics_pair';
+import Comment from './chord_sheet/comment';
+import Line from './chord_sheet/line';
+import Literal from './chord_sheet/chord_pro/literal';
+import SoftLineBreak from './chord_sheet/soft_line_break';
+import Song from './chord_sheet/song';
+import SongBuilder from './song_builder';
+import Tag from './chord_sheet/tag';
+import Ternary from './chord_sheet/chord_pro/ternary';
+import { SerializedChordDefinition, SerializedChordLyricsPair, SerializedComment, SerializedComponent, SerializedLine, SerializedLiteral, SerializedSong, SerializedTag, SerializedTernary } from './serialized_types';
+/**
+ * Serializes a song into een plain object, and deserializes the serialized object back into a {@link Song}
+ */
+declare class ChordSheetSerializer {
+    song: Song;
+    songBuilder: SongBuilder;
+    /**
+     * Serializes the chord sheet to a plain object, which can be converted to any format like JSON, XML etc
+     * Can be deserialized using {@link deserialize}
+     * @returns object A plain JS object containing all chord sheet data
+     */
+    serialize(song: Song): SerializedSong;
+    serializeLine(line: Line): SerializedLine;
+    serializeItem(item: AstType): SerializedComponent;
+    serializeChordDefinition(chordDefinition: ChordDefinition): SerializedChordDefinition;
+    serializeTag(tag: Tag): SerializedTag;
+    serializeChordLyricsPair(chordLyricsPair: ChordLyricsPair): SerializedChordLyricsPair;
+    serializeTernary(ternary: Ternary): object;
+    serializeLiteral(literal: Literal): string;
+    serializeExpression(expression: AstType[]): SerializedComponent[];
+    serializeComment(comment: Comment): SerializedComment;
+    /**
+     * Deserializes a song that has been serialized using {@link serialize}
+     * @param {object} serializedSong The serialized song
+     * @returns {Song} The deserialized song
+     */
+    deserialize(serializedSong: SerializedSong): Song;
+    parseAstComponent(astComponent: SerializedComponent): null | ChordLyricsPair | Tag | Comment | Ternary | Literal | SoftLineBreak;
+    parseChordSheet(astComponent: SerializedSong): void;
+    parseLine(astComponent: SerializedLine): void;
+    parseChordLyricsPair(astComponent: SerializedChordLyricsPair): ChordLyricsPair;
+    parseTag(astComponent: SerializedTag): Tag;
+    parseComment(astComponent: SerializedComment): Comment;
+    parseTernary(astComponent: SerializedTernary): Ternary;
+    parseExpression(expression: (SerializedLiteral | SerializedTernary)[]): (AstType | null)[];
+}
+export default ChordSheetSerializer;

package/lib/pdf/constants.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Used to mark a paragraph as bridge
+ * @constant
+ * @type {string}
+ */
+export declare const BRIDGE = "bridge";
+/**
+ * Used to mark a paragraph as chorus
+ * @constant
+ * @type {string}
+ */
+export declare const CHORUS = "chorus";
+/**
+ * Used to mark a paragraph as grid
+ * @constant
+ * @type {string}
+ */
+export declare const GRID = "grid";
+/**
+ * Used to mark a paragraph as containing lines with both verse and chorus type
+ * @constant
+ * @type {string}
+ */
+export declare const INDETERMINATE = "indeterminate";
+/**
+ * Used to mark a paragraph as not containing a line marked with a type
+ * @constant
+ * @type {string}
+ */
+export declare const NONE = "none";
+/**
+ * Used to mark a paragraph as tab
+ * @constant
+ * @type {string}
+ */
+export declare const TAB = "tab";
+/**
+ * Used to mark a paragraph as verse
+ * @constant
+ * @type {string}
+ */
+export declare const VERSE = "verse";
+/**
+ * Used to mark a paragraph as part
+ * @constant
+ * @type {string}
+ */
+export declare const PART = "part";
+/**
+ * Used to mark a section as Lilypond notation
+ * @constant
+ * @type {string}
+ */
+export declare const LILYPOND = "ly";
+/**
+ * Used to mark a section as ABC music notation
+ * @constant
+ * @type {string}
+ */
+export declare const ABC = "abc";
+/**
+ * Used to mark a section as SVG image
+ * @constant
+ * @type {string}
+ */
+export declare const SVG = "svg";
+/**
+ * Used to mark a paragraph as textblock
+ * @constant
+ * @type {string}
+ */
+export declare const TEXTBLOCK = "textblock";
+export type ParagraphType = 'abc' | 'bridge' | 'chorus' | 'grid' | 'indeterminate' | 'ly' | 'none' | 'svg' | 'tab' | 'textblock' | 'verse' | 'part' | string;
+export declare const SYMBOL = "symbol";
+export declare const NUMERIC = "numeric";
+export declare const NUMERAL = "numeral";
+export declare const SOLFEGE = "solfege";
+export declare const ROMAN_NUMERALS: string[];
+export declare const FLAT = "b";
+export declare const SHARP = "#";
+export type Accidental = '#' | 'b';
+export declare const NO_ACCIDENTAL = "NM";
+export type NoAccidental = 'NM';
+export type AccidentalMaybe = Accidental | NoAccidental;
+/**
+ * @deprecated Use Accidental instead
+ */
+export type Modifier = Accidental;
+/**
+ * @deprecated Use NO_ACCIDENTAL instead
+ */
+export declare const NO_MODIFIER = "NM";
+/**
+ * @deprecated Use NoAccidental instead
+ */
+export type NoModifier = NoAccidental;
+/**
+ * @deprecated Use AccidentalMaybe instead
+ */
+export type ModifierMaybe = AccidentalMaybe;
+export type ChordType = 'symbol' | 'solfege' | 'numeric' | 'numeral';
+export type ChordStyle = 'symbol' | 'solfege' | 'number' | 'numeral';
+export type NullableChordStyle = ChordStyle | null;
+export declare const MINOR = "m";
+export declare const MAJOR = "M";
+export type Mode = 'M' | 'm';
+export type FretNumber = number;
+export type OpenFret = 0;
+export type NonSoundingString = '-1' | 'N' | 'x';
+export type StringNumber = 1 | 2 | 3 | 4 | 5 | 6;
+export type FingerNumber = 1 | 2 | 3 | 4 | 5 | OpenFret;
+export declare const nonSoundingString: NonSoundingString[];
+export declare const openFret: OpenFret;
+export type Fret = FretNumber | OpenFret | NonSoundingString;
+export declare const START_TAG = "start_tag";
+export declare const END_TAG = "end_tag";
+export declare const AUTO = "auto";

package/lib/pdf/formatter/chord_pro_formatter.d.ts

@@ -0,0 +1,39 @@
+import ChordLyricsPair from '../chord_sheet/chord_lyrics_pair';
+import Comment from '../chord_sheet/comment';
+import Evaluatable from '../chord_sheet/chord_pro/evaluatable';
+import Formatter from './formatter';
+import Item from '../chord_sheet/item';
+import Line from '../chord_sheet/line';
+import Metadata from '../chord_sheet/metadata';
+import Song from '../chord_sheet/song';
+import Tag from '../chord_sheet/tag';
+import Ternary from '../chord_sheet/chord_pro/ternary';
+/**
+ * Formats a song into a ChordPro chord sheet
+ */
+declare class ChordProFormatter extends Formatter {
+    /**
+     * Formats a song into a ChordPro chord sheet.
+     * @param {Song} song The song to be formatted
+     * @returns {string} The ChordPro string
+     */
+    format(song: Song): string;
+    private separateMetadataFromContent;
+    private formatMetadataSection;
+    private formatContentSection;
+    private combineMetadataAndContent;
+    formatLine(line: Line, metadata: Metadata): string;
+    formatItem(item: Item, metadata: Metadata): string;
+    formatOrEvaluateItem(item: Evaluatable, metadata: Metadata): string;
+    formatTernary(ternary: Ternary): string;
+    formatValueTest(valueTest: string | null): string;
+    formatExpressionRange(expressionRange: Evaluatable[]): string;
+    formatExpression(expression: Evaluatable): string;
+    formatTag(tag: Tag): string;
+    formatTagAttributes(tag: Tag): string;
+    formatChordLyricsPair(chordLyricsPair: ChordLyricsPair): string;
+    formatChordLyricsPairChords(chordLyricsPair: ChordLyricsPair): string;
+    formatChordLyricsPairLyrics(chordLyricsPair: ChordLyricsPair): string;
+    formatComment(comment: Comment): string;
+}
+export default ChordProFormatter;

package/lib/pdf/formatter/chord_renderer.d.ts

@@ -0,0 +1,30 @@
+import Key from '../key';
+import { NullableChordStyle } from '../constants';
+interface ConstructorOptions {
+    capo: number;
+    contextKey: Key | null;
+    decapo: boolean;
+    normalizeChords: boolean;
+    renderKey: Key | null;
+    songKey: Key | null;
+    style: NullableChordStyle;
+    transposeKey: string | null;
+    useUnicodeModifier: boolean;
+}
+declare class ChordRenderer {
+    capo: number;
+    contextKey: Key | null;
+    normalizeChords: boolean;
+    renderKey: Key | null;
+    songKey: Key | null;
+    style: NullableChordStyle;
+    transposeKey: string | null;
+    useUnicodeModifier: boolean;
+    constructor(options?: Partial<ConstructorOptions>);
+    render(chordString: string): string;
+    private changeChordType;
+    private get accidental();
+    private get effectiveKey();
+    private get effectiveTransposeDistance();
+}
+export default ChordRenderer;

package/lib/pdf/formatter/chords_over_words_formatter.d.ts

@@ -0,0 +1,33 @@
+import ChordLyricsPair from '../chord_sheet/chord_lyrics_pair';
+import Formatter from './formatter';
+import Item from '../chord_sheet/item';
+import Line from '../chord_sheet/line';
+import Metadata from '../chord_sheet/metadata';
+import Paragraph from '../chord_sheet/paragraph';
+import Song from '../chord_sheet/song';
+/**
+ * Formats a song into a plain text chord sheet
+ */
+declare class ChordsOverWordsFormatter extends Formatter {
+    song: Song;
+    /**
+     * Formats a song into a plain text chord sheet
+     * @param {Song} song The song to be formatted
+     * @returns {string} the chord sheet
+     */
+    format(song: Song): string;
+    formatHeader(): string;
+    formatParagraphs(): string;
+    formatParagraph(paragraph: Paragraph, metadata: Metadata): string;
+    formatLine(line: Line, metadata: Metadata): string;
+    formatLineTop(line: Line, metadata: Metadata): string | null;
+    chordLyricsPairLength(chordLyricsPair: ChordLyricsPair, line: Line): number;
+    formatItemTop(item: Item, _metadata: Metadata, line: Line): string;
+    renderChord(item: ChordLyricsPair, line: Line): string;
+    formatLineBottom(line: any, metadata: any): string | null;
+    formatLineWithFormatter(line: Line, formatter: (_item: Item, _metadata: Metadata, _line: Line) => string, metadata: Metadata): string;
+    formatItemBottom(item: Item, metadata: Metadata, line: Line): string;
+    private formatEvaluatable;
+    private formatChordLyricsPair;
+}
+export default ChordsOverWordsFormatter;