chordsheetjs 15.0.0 → 15.0.1

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

@@ -1,253 +0,0 @@
-import Chord from '../chord';
-import ChordDefinition from '../chord_definition/chord_definition';
-import ChordDefinitionSet from '../chord_definition/chord_definition_set';
-import ChordLyricsPair from './chord_lyrics_pair';
-import Configuration from '../formatter/configuration';
-import FormattingContext from '../formatter/formatting_context';
-import Item from './item';
-import Key from '../key';
-import Line from './line';
-import Metadata from './metadata';
-import MetadataAccessors from './metadata_accessors';
-import Paragraph from './paragraph';
-import ParserWarning from '../parser/parser_warning';
-import { Accidental } from '../constants';
-type MapItemsCallback = (_item: Item) => Item | Item[] | null;
-/**
- * Represents a song in a chord sheet. Currently a chord sheet can only have one song.
- */
-declare class Song extends MetadataAccessors {
-    /**
-     * The {@link Line} items of which the song consists
-     * @member {Line[]}
-     */
-    lines: Line[];
-    _bodyLines: Line[] | null;
-    _bodyParagraphs: Paragraph[] | null;
-    _renderParagraphs: Paragraph[] | null;
-    warnings: ParserWarning[];
-    _metadata: Metadata | null;
-    /**
-     * Creates a new {Song} instance
-     * @param metadata {Record<string, string | string[]>|Metadata} predefined metadata
-     */
-    constructor(metadata?: Record<string, string | string[]> | Metadata | null);
-    /** Returns song lines, skipping leading empty/meta-only lines. @returns {Line[]} */
-    get bodyLines(): Line[];
-    /** Returns song paragraphs, skipping paragraphs with only empty lines. @returns {Paragraph[]} */
-    get bodyParagraphs(): Paragraph[];
-    get renderParagraphs(): Paragraph[];
-    set renderParagraphs(paragraphs: Paragraph[]);
-    selectRenderableItems(items: (Line | Paragraph)[]): (Line | Paragraph)[];
-    /** The {@link Paragraph} items of which the song consists @member {Paragraph[]} */
-    get paragraphs(): Paragraph[];
-    /** The body paragraphs with any `{chorus}` tag expanded into the targeted chorus */
-    get expandedBodyParagraphs(): Paragraph[];
-    filterParagraphs(paragraphs: Paragraph[], configuration: Configuration): Paragraph[];
-    linesToParagraphs(lines: Line[]): Paragraph[];
-    /** Returns a deep clone of the song @returns {Song} */
-    clone(): Song;
-    getMetadataValue(name: string): string | string[] | null;
-    getSingleMetadataValue(name: string): string | null;
-    /**
-     * Returns a copy of the song with the key value set to the specified key. It changes:
-     * - the value for `key` in the {@link metadata} set
-     * - any existing `key` directive
-     * @param {number|null} key the key. Passing `null` will:
-     * - remove the current key from {@link metadata}
-     * - remove any `key` directive
-     * @returns {Song} The changed song
-     */
-    setKey(key: string | number | null): Song;
-    /**
-     * Returns a copy of the song with the key value set to the specified capo. It changes:
-     * - the value for `capo` in the {@link metadata} set
-     * - any existing `capo` directive
-     * @param {number|null} capo the capo. Passing `null` will:
-     * - remove the current key from {@link metadata}
-     * - remove any `capo` directive
-     * @returns {Song} The changed song
-     */
-    setCapo(capo: number | null): Song;
-    private updateDirectives;
-    private changeOrDeleteDirectives;
-    private insertDirectives;
-    private findInsertIndex;
-    private isInsertionPoint;
-    private adjustInsertIndex;
-    private createMetadataLines;
-    private prepareLinesToInsert;
-    private spliceLines;
-    /**
-     * Transposes the song by the specified delta. It will:
-     * - transpose all chords, see: {@link Chord#transpose}
-     * - transpose the song key in {@link metadata}
-     * - update any existing `key` directive
-     * @param {number} delta The number of semitones (positive or negative) to transpose with
-     * @param {Object} [options={}] options
-     * @param {boolean} [options.normalizeChordSuffix=false] whether to normalize the chord suffixes after transposing
-     * @returns {Song} The transposed song
-     */
-    transpose(delta: number, { accidental, normalizeChordSuffix }?: {
-        accidental?: Accidental | null;
-        normalizeChordSuffix?: boolean;
-    }): Song;
-    private static transposeChordLyricsPair;
-    private static transposeLiteral;
-    /**
-     * Transposes the song up by one semitone. It will:
-     * - transpose all chords, see: {@link Chord#transpose}
-     * - transpose the song key in {@link metadata}
-     * - update any existing `key` directive
-     * @param {Object} [options={}] options
-     * @param {boolean} [options.normalizeChordSuffix=false] whether to normalize the chord suffixes after transposing
-     * @returns {Song} The transposed song
-     */
-    transposeUp({ normalizeChordSuffix }?: {
-        normalizeChordSuffix?: boolean;
-    }): Song;
-    /**
-     * Transposes the song down by one semitone. It will:
-     * - transpose all chords, see: {@link Chord#transpose}
-     * - transpose the song key in {@link metadata}
-     * - update any existing `key` directive
-     * @param {Object} [options={}] options
-     * @param {boolean} [options.normalizeChordSuffix=false] whether to normalize the chord suffixes after transposing
-     * @returns {Song} The transposed song
-     */
-    transposeDown({ normalizeChordSuffix }?: {
-        normalizeChordSuffix?: boolean;
-    }): Song;
-    /**
-     * Returns a copy of the song with the key set to the specified key. It changes:
-     * - the value for `key` in the {@link metadata} set
-     * - any existing `key` directive
-     * - all chords, those are transposed according to the distance between the current and the new key
-     * @param {string} newKey The new key.
-     * @returns {Song} The changed song
-     */
-    changeKey(newKey: string | Key): Song;
-    /**
-     * Returns a copy of the song with all chords changed to the specified accidental.
-     *
-     * Examples:
-     *
-     * ```js
-     * song.useAccidental('#');
-     * song.useAccidental('b');
-     * ```
-     *
-     * @param {Accidental} accidental the new accidental
-     * @returns {Song} the changed song
-     */
-    useAccidental(accidental: Accidental): Song;
-    /**
-     * @deprecated Use useAccidental instead
-     */
-    useModifier(accidental: Accidental): Song;
-    /**
-     * Returns a copy of the song with all chords normalized to the specified key. See {@link Chord#normalize}.
-     * @param key the key to normalize to
-     * @param options options
-     * @param options.normalizeSuffix whether to normalize the chord suffixes
-     */
-    normalizeChords(key?: Key | string | null, { normalizeSuffix }?: {
-        normalizeSuffix?: boolean;
-    }): Song;
-    mapChordLyricsPairs(func: (pair: ChordLyricsPair) => ChordLyricsPair): Song;
-    changeChords(func: (chord: Chord) => Chord): Song;
-    private static isMusicalSection;
-    private static mapChordsInLiteral;
-    get currentKey(): Key | null;
-    requireCurrentKey(): Key;
-    /**
-     * Returns a copy of the song with the directive value(s) set to the specified value(s).
-     * - when there is a matching directive in the song, it will update the directive
-     * - when there is no matching directive, it will be inserted
-     * If `value` is `null` it will act as a delete, any directive matching `name` will be removed.
-     *
-     * @example
-     * ```javascript
-     * song.changeMetadata('author', 'John');
-     * song.changeMetadata('composer', ['Jane', 'John']);
-     * song.changeMetadata('key', null); // Remove key directive
-     * ```
-     * @param name The directive name
-     * @param {string | string[] | null} value The value to set, or `null` to remove the directive
-     * @return {Song} The changed song
-     */
-    changeMetadata(name: string, value: string | string[] | null): Song;
-    /**
-     * Returns a copy of the song with the metadata changed. It will:
-     * - update the metadata
-     * - update any existing directive matching the metadata key
-     * - insert a new directive if it does not exist
-     * @example
-     * ```javascript
-     * song.changeMetadata({
-     *   author: 'John',
-     *   composer: ['Jane', 'John'],
-     *   key: null, // Remove key directive
-     * });
-     * ```
-     * @param {Record<string, string | string[] | null>} metadata The metadata to change
-     */
-    changeMetadata(metadata: Record<string, string | string[] | null>): Song;
-    addLine(line: Line): void;
-    /**
-     * 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: MapItemsCallback): Song;
-    foreachItem(func: (_item: Item) => void): void;
-    /**
-     * Returns all unique chords used in the song
-     * @returns {string[]} the chords
-     */
-    getChords(): string[];
-    /**
-     * Returns all chord definitions from the song.
-     * Definitions are made using the `{chord}` or `{define}` directive.
-     * A chord definitions overrides a previous chord definition for the exact same chord.
-     * @returns {Record<string, ChordDefinition>} the chord definitions
-     * @see https://chordpro.org/chordpro/directives-define/
-     * @see https://chordpro.org/chordpro/directives-chord/
-     */
-    getChordDefinitions(context?: FormattingContext): Record<string, ChordDefinition>;
-    /**
-     * The song's metadata. When there is only one value for an entry, the value is a string. Else, the value is
-     * an array containing all unique values for the entry.
-     * @type {Metadata}
-     */
-    get metadata(): Metadata;
-    getMetadata(configuration?: Configuration): Metadata;
-    get chordDefinitions(): ChordDefinitionSet;
-    /**
-     * 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: (_line: Line) => Line | null): Song;
-    private updateItem;
-    private removeItem;
-}
-export default Song;

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

@@ -1,15 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,104 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,259 +0,0 @@
-/**
- * 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

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