chordsheetjs 15.0.0 → 15.0.1

package/lib/pdf/chord_sheet/chord_pro/ternary.d.ts

@@ -1,29 +0,0 @@
-import Evaluatable from './evaluatable';
-import Metadata from '../metadata';
-import TraceInfo from '../trace_info';
-export type TernaryProperties = TraceInfo & {
-    variable?: string | null;
-    valueTest?: string | null;
-    trueExpression?: Evaluatable[];
-    falseExpression?: Evaluatable[];
-};
-declare class Ternary extends Evaluatable {
-    variable: string | null;
-    valueTest: string | null;
-    trueExpression: Evaluatable[];
-    falseExpression: Evaluatable[];
-    constructor({ variable, valueTest, trueExpression, falseExpression, line, column, offset, }: TernaryProperties);
-    /**
-     * Evaluate the meta expression
-     * @param {Metadata} metadata The metadata object to use for evaluating the expression
-     * @param {string} [metadataSeparator=null] The metadata separator to use if necessary
-     * @returns {string} The evaluated expression
-     */
-    evaluate(metadata: Metadata, metadataSeparator: string, upperContext?: string | null): string;
-    evaluateToString(value: string[] | string, metadataSeparator: string): string;
-    evaluateWithVariable(metadata: Metadata, metadataSeparator: string): string;
-    evaluateForTruthyValue(metadata: Metadata, metadataSeparator: string, value: string | string[]): string;
-    isRenderable(): boolean;
-    clone(): Ternary;
-}
-export default Ternary;

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

@@ -1,21 +0,0 @@
-import type Line from './line';
-/**
- * Represents a comment. See https://www.chordpro.org/chordpro/chordpro-file-format-specification/#overview
- */
-declare class Comment {
-    content: string;
-    parentLine: Line | null;
-    constructor(content: string);
-    /**
-     * Indicates whether a Comment should be visible in a formatted chord sheet (except for ChordPro sheets)
-     * @returns {boolean}
-     */
-    isRenderable(): boolean;
-    /**
-     * Returns a deep copy of the Comment, useful when programmatically transforming a song
-     * @returns {Comment}
-     */
-    clone(): Comment;
-    toString(): string;
-}
-export default Comment;

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

@@ -1,47 +0,0 @@
-import FontSize from './font_size';
-interface FontProperties {
-    font?: string | null;
-    size?: FontSize | null;
-    colour?: string | null;
-}
-declare class Font {
-    /**
-     * The font
-     * @member {string | null}
-     */
-    font: string | null;
-    /**
-     * The font size, expressed in either pixels or percentage.
-     * @member {FontSize | null}
-     */
-    size: FontSize | null;
-    /**
-     * The font color
-     * @member {string | null}
-     */
-    colour: string | null;
-    constructor({ font, size, colour }?: FontProperties);
-    clone(): Font;
-    /**
-     * Converts the font, size and color to a CSS string.
-     * If possible, font and size are combined to the `font` shorthand.
-     * If `font` contains double quotes (`"`) those will be converted to single quotes (`'`).
-     *
-     * @example
-     * // Returns "font-family: 'Times New Roman'"
-     * new Font({ font: '"Times New Roman"' }).toCssString()
-     * @example
-     * // Returns "color: red; font-family: Verdana"
-     * new Font({ font: 'Verdana', colour: 'red' }).toCssString()
-     * @example
-     * // Returns "font: 30px Verdana"
-     * new Font({ font: 'Verdana', size: '30' }).toCssString()
-     * @example
-     * // Returns "color: blue; font: 30% Verdana"
-     * new Font({ font: 'Verdana', size: '30%', colour: 'blue' }).toCssString()
-     *
-     * @return {string} The CSS string
-     */
-    toCssString(): string;
-}
-export default Font;

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

@@ -1,33 +0,0 @@
-type Size = 'px' | '%';
-declare class FontSize {
-    /**
-     * The size unit, either `"px"` or `"%"`
-     * @member {string}
-     */
-    unit: Size;
-    /**
-     * The font size
-     * @member {number}
-     */
-    fontSize: number;
-    constructor(fontSize: number, kind: Size);
-    clone(): FontSize;
-    multiply(percentage: any): FontSize;
-    /**
-     * Stringifies the font size by concatenating size and unit
-     *
-     * @example
-     * // Returns "30px"
-     * new FontSize(30, 'px').toString()
-     * @example
-     * // Returns "120%"
-     * new FontSize(120, '%').toString()
-     *
-     * @return {string} The font size
-     */
-    toString(): string;
-    static parse(fontSize: string, parent: FontSize | null): FontSize;
-    static parseNotANumber(parent: FontSize | null): FontSize;
-    static parsePercentage(parsedFontSize: number, parent: FontSize | null): FontSize;
-}
-export default FontSize;

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

@@ -1,13 +0,0 @@
-import Font from './font';
-import FontSize from './font_size';
-import Tag from './tag';
-declare class FontStack {
-    fontAndColourStacks: Record<string, string[]>;
-    sizeStacks: Record<string, FontSize[]>;
-    textFont: Font;
-    chordFont: Font;
-    applyTag(tag: Tag): void;
-    private pushOrPopTag;
-    private pushOrPopSizeTag;
-}
-export default FontStack;

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

@@ -1,7 +0,0 @@
-import ChordLyricsPair from './chord_lyrics_pair';
-import Comment from './comment';
-import Literal from './chord_pro/literal';
-import Tag from './tag';
-import Ternary from './chord_pro/ternary';
-type Item = ChordLyricsPair | Comment | Tag | Ternary | Literal;
-export default Item;

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

@@ -1,130 +0,0 @@
-import ChordLyricsPair from './chord_lyrics_pair';
-import Comment from './comment';
-import Font from './font';
-import Item from './item';
-import Tag from './tag';
-import { ContentType, PartTypes } from '../serialized_types';
-type MapItemFunc = (_item: Item) => Item | null;
-export type LineType = 'bridge' | 'chorus' | 'none' | 'tab' | 'verse' | ContentType | 'indeterminate' | PartTypes;
-/**
- * Represents a line in a chord sheet, consisting of items of type ChordLyricsPair or Tag
- */
-declare class Line {
-    /**
-     * The items ({@link ChordLyricsPair} or {@link Tag} or {@link Comment}) of which the line consists
-     * @type {Array.<(ChordLyricsPair|Tag|Comment)>}
-     */
-    items: Item[];
-    /**
-     * The line type, This is set by the ChordProParser when it read tags like {start_of_chorus} or {start_of_verse}
-     * It uses the following mapping to determine the line type from directives:
-     * - `start_of_abc` => {@link ABC}
-     * - `start_of_bridge` => {@link BRIDGE}
-     * - `start_of_chorus` => {@link CHORUS}
-     * - `start_of_grid` => {@link GRID}
-     * - `start_of_ly` => {@link LILYPOND}
-     * - `start_of_tab` => {@link TAB}
-     * - `start_of_verse` => {@link VERSE}
-     *
-     * There are two special cases:
-     * - {@link INDETERMINATE} when the paragraph lines do not have a consistent type
-     * - {@link NONE} when no type is derived
-     * @type {string}
-     */
-    type: string;
-    currentChordLyricsPair: ChordLyricsPair;
-    key: string | null;
-    transposeKey: string | null;
-    lineNumber: number | null;
-    selector: string | null;
-    selectorIsNegated: boolean;
-    /**
-     * The text font that applies to this line. Is derived from the directives:
-     * `textfont`, `textsize` and `textcolour`
-     * See: https://www.chordpro.org/chordpro/directives-props_text_legacy/
-     * @type {Font}
-     */
-    textFont: Font;
-    /**
-     * The chord font that applies to this line. Is derived from the directives:
-     * `chordfont`, `chordsize` and `chordcolour`
-     * See: https://www.chordpro.org/chordpro/directives-props_chord_legacy/
-     * @type {Font}
-     */
-    chordFont: Font;
-    constructor({ type, items }?: {
-        type: string;
-        items: Item[];
-    });
-    /**
-     * Indicates whether the line contains any items
-     * @returns {boolean}
-     */
-    isEmpty(): boolean;
-    /**
-     * Adds an item ({@link ChordLyricsPair} or {@link Tag}) to the line
-     * @param {ChordLyricsPair|Tag} item The item to be added
-     */
-    addItem(item: Item): void;
-    /**
-     * Indicates whether the line contains items that are renderable
-     * @returns {boolean}
-     */
-    hasRenderableItems(): boolean;
-    /**
-     * Returns a deep copy of the line and all of its items
-     * @returns {Line}
-     */
-    clone(): Line;
-    mapItems(func: MapItemFunc | null): Line;
-    /**
-     * Indicates whether the line type is {@link BRIDGE}
-     * @returns {boolean}
-     */
-    isBridge(): boolean;
-    /**
-     * Indicates whether the line type is {@link CHORUS}
-     * @returns {boolean}
-     */
-    isChorus(): boolean;
-    /**
-     * Indicates whether the line type is {@link GRID}
-     * @returns {boolean}
-     */
-    isGrid(): boolean;
-    /**
-     * Indicates whether the line type is {@link TAB}
-     * @returns {boolean}
-     */
-    isTab(): boolean;
-    /**
-     * Indicates whether the line type is {@link VERSE}
-     * @returns {boolean}
-     */
-    isVerse(): boolean;
-    /**
-     * Indicates whether the line type is {@link PART}
-     * @returns {boolean}
-     */
-    isPart(): boolean;
-    /**
-     * Indicates whether the line contains items that are renderable. Please use {@link hasRenderableItems}
-     * @deprecated
-     * @returns {boolean}
-     */
-    hasContent(): boolean;
-    addChordLyricsPair(chords?: ChordLyricsPair | string | null, lyrics?: null): ChordLyricsPair;
-    ensureChordLyricsPair(): void;
-    chords(chr: string): void;
-    lyrics(chr: string): void;
-    addTag(nameOrTag: Tag | string, value?: string | null): Tag;
-    addComment(content: Comment | string): Comment;
-    set(properties: {
-        type?: string;
-        items?: Item[];
-    }): Line;
-    get _tag(): Tag | null;
-    isSectionStart(): boolean;
-    isSectionEnd(): boolean;
-}
-export default Line;

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

@@ -1,12 +0,0 @@
-import Line from './line';
-import Song from './song';
-declare class LineExpander {
-    line: Line;
-    song: Song;
-    static expand(line: Line, song: Song): Line[];
-    constructor(line: Line, song: Song);
-    expand(): Line[];
-    private getLastChorusBefore;
-    private lineHasMoreThanChorusDirectives;
-}
-export default LineExpander;

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

@@ -1,71 +0,0 @@
-import MetadataAccessors from './metadata_accessors';
-type MetadataProvider = () => string | null;
-/**
- * Stores song metadata. Properties can be accessed using the get() method:
- *
- * const metadata = new Metadata({ author: 'John' });
- * metadata.get('author')   // => 'John'
- *
- * See {@link Metadata#get}
- */
-declare class Metadata extends MetadataAccessors implements Iterable<[string, string | string[]]> {
-    metadata: Record<string, string | string[]>;
-    providers: Map<string, MetadataProvider>;
-    constructor(metadata?: Record<string, string | string[]> | Metadata);
-    merge(metadata?: Record<string, string | string[]> | Metadata): Metadata;
-    contains(key: string): boolean;
-    add(key: string, value: string): void;
-    appendValue(key: string, value: string): void;
-    setProvider(key: string, provider: MetadataProvider): void;
-    set(key: string, value: string | null): void;
-    getMetadataValue(name: string): string | string[] | null;
-    getSingleMetadataValue(name: string): string | null;
-    /**
-     * Reads a metadata value by key. This method supports simple value lookup, as well as fetching single array values.
-     *
-     * This method deprecates direct property access, eg: metadata['author']
-     *
-     * @example
-     * const metadata = new Metadata({ lyricist: 'Pete', author: ['John', 'Mary'] });
-     * metadata.get('lyricist') // => 'Pete'
-     * metadata.get('author')   // => ['John', 'Mary']
-     * metadata.get('author.1') // => 'John'
-     * metadata.get('author.2') // => 'Mary'
-     *
-     * Using a negative index will start counting at the end of the list:
-     *
-     * const metadata = new Metadata({ lyricist: 'Pete', author: ['John', 'Mary'] });
-     * metadata.get('author.-1') // => 'Mary'
-     * metadata.get('author.-2') // => 'John'
-     *
-     * @param prop the property name
-     * @returns {Array<String>|String} the metadata value(s). If there is only one value, it will return a String,
-     * else it returns an array of strings.
-     */
-    get(prop: string): string | string[] | null;
-    /**
-     * Returns all metadata values, including provider values and generated values like `_key`.
-     * @returns {Object.<string, string|string[]>} the metadata values
-     */
-    all(): Record<string, string | string[]>;
-    ownMetadata(): Record<string, string | string[]>;
-    [Symbol.iterator](): IterableIterator<[string, string | string[]]>;
-    /**
-     * Returns a single metadata value. If the actual value is an array, it returns the first value. Else, it returns
-     * the value.
-     * @ignore
-     * @param {string} prop the property name
-     * @returns {String} The metadata value
-     */
-    getSingle(prop: string): string | null;
-    parseArrayKey(prop: string): [string, number] | null;
-    getArrayItem(prop: string): string | null;
-    /**
-     * Returns a deep clone of this Metadata object
-     * @returns {Metadata} the cloned Metadata object
-     */
-    clone(): Metadata;
-    calculateKeyFromCapo(): string | null;
-    assign(metadata: Record<string, string | string[] | null>): void;
-}
-export default Metadata;

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

@@ -1,18 +0,0 @@
-declare abstract class MetadataAccessors {
-    abstract getMetadataValue(_name: string): string | string[] | null;
-    abstract getSingleMetadataValue(_name: string): string | null;
-    get key(): string | null;
-    get title(): string | null;
-    get subtitle(): string | null;
-    get capo(): string | string[] | null;
-    get duration(): string | null;
-    get tempo(): string | null;
-    get time(): string | string[] | null;
-    get year(): string | null;
-    get album(): string | string[] | null;
-    get copyright(): string | null;
-    get lyricist(): string | string[] | null;
-    get artist(): string | string[] | null;
-    get composer(): string | string[] | null;
-}
-export default MetadataAccessors;

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

@@ -1,48 +0,0 @@
-import Line from './line';
-/**
- * Represents a paragraph of lines in a chord sheet
- */
-declare class Paragraph {
-    /**
-     * The {@link Line} items of which the paragraph consists
-     * @member
-     * @type {Line[]}
-     */
-    lines: Line[];
-    addLine(line: any): void;
-    /**
-     * Indicates whether the paragraph only contains literals. If true, {@link contents} can be used to retrieve
-     * the paragraph contents as one string where lines are separated by newlines.
-     * @see {@link contents}
-     * @returns {boolean}
-     */
-    isLiteral(): boolean;
-    /**
-     * Returns the paragraph contents as one string where lines are separated by newlines
-     * @returns {string}
-     */
-    get contents(): string;
-    /**
-     * Returns the label of the paragraph. The label is the value of the first section delimiter tag
-     * in the first line.
-     * @returns {string|null}
-     */
-    get label(): string | null;
-    /**
-     * Tries to determine the common type for all lines. If the types for all lines are equal, it returns that type.
-     * If not, it returns {@link INDETERMINATE}
-     * For the possible values, see {@link Line.type}
-     * @returns {string}
-     */
-    get type(): string;
-    get selector(): string | null;
-    get selectorIsNegated(): boolean;
-    /**
-     * Indicates whether the paragraph contains lines with renderable items.
-     * @see {@link Line.hasRenderableItems}
-     * @returns {boolean}
-     */
-    hasRenderableItems(): boolean;
-    isEmpty(): boolean;
-}
-export default Paragraph;

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

@@ -1,15 +0,0 @@
-/**
- * Represents a soft line break in the lyrics, typically rendered as a space or optional break point.
- */
-declare class SoftLineBreak {
-    /**
-     * The content of the soft line break, defaults to a single space.
-     */
-    content: string;
-    constructor(content?: string);
-    /**
-     * Returns a copy of the SoftLineBreak.
-     */
-    clone(): SoftLineBreak;
-}
-export default SoftLineBreak;