chordsheetjs 15.0.0 → 15.0.1

package/lib/pdf/parser/chords_over_words/helpers.d.ts

@@ -1,33 +0,0 @@
-import { SerializedChord, SerializedLine } from '../../serialized_types';
-type CarriageReturn = '\r';
-type LineFeed = '\n';
-type CarriageReturnLineFeed = '\r\n';
-type NewLine = CarriageReturn | LineFeed | CarriageReturnLineFeed;
-type Lyrics = string;
-type Chord = {
-    column: number;
-    value: string;
-} & SerializedChord;
-interface RhythmSymbol {
-    type: 'symbol';
-    value: '/' | '|' | '-' | 'x';
-    column: number;
-}
-interface NoChord {
-    type: 'noChord';
-    value: string;
-    column: number;
-}
-type DirectionLine = SerializedLine;
-type InlineMetadata = SerializedLine;
-interface ChordsLine {
-    type: 'chordsLine';
-    items: (Chord | RhythmSymbol | NoChord)[];
-}
-interface LyricsLine {
-    type: 'lyricsLine';
-    content: Lyrics;
-}
-type ChordSheetLine = DirectionLine | InlineMetadata | ChordsLine | LyricsLine;
-export declare function composeChordSheetContents(newLine: NewLine | null, lines: ChordSheetLine[], trailingLine: ChordSheetLine | null, chopFirstWord: boolean): SerializedLine[];
-export {};

package/lib/pdf/parser/chords_over_words/peg_parser.d.ts

@@ -1,55 +0,0 @@
-export interface FilePosition {
-    offset: number;
-    line: number;
-    column: number;
-}
-export interface FileRange {
-    start: FilePosition;
-    end: FilePosition;
-    source: string;
-}
-export interface LiteralExpectation {
-    type: "literal";
-    text: string;
-    ignoreCase: boolean;
-}
-export interface ClassParts extends Array<string | ClassParts> {
-}
-export interface ClassExpectation {
-    type: "class";
-    parts: ClassParts;
-    inverted: boolean;
-    ignoreCase: boolean;
-}
-export interface AnyExpectation {
-    type: "any";
-}
-export interface EndExpectation {
-    type: "end";
-}
-export interface OtherExpectation {
-    type: "other";
-    description: string;
-}
-export type Expectation = LiteralExpectation | ClassExpectation | AnyExpectation | EndExpectation | OtherExpectation;
-export declare class PeggySyntaxError extends Error {
-    static buildMessage(expected: Expectation[], found: string | null): string;
-    message: string;
-    expected: Expectation[];
-    found: string | null;
-    location: FileRange;
-    name: string;
-    constructor(message: string, expected: Expectation[], found: string | null, location: FileRange);
-    format(sources: {
-        grammarSource?: string;
-        text: string;
-    }[]): string;
-}
-export interface ParseOptions {
-    filename?: string;
-    startRule?: string;
-    tracer?: any;
-    [key: string]: any;
-}
-export type ParseFunction = (input: string, options?: ParseOptions) => any;
-export declare const parse: ParseFunction;

package/lib/pdf/parser/chords_over_words_parser.d.ts

@@ -1,67 +0,0 @@
-import ParserWarning from './parser_warning';
-import Song from '../chord_sheet/song';
-import { ParseOptions } from './chords_over_words/peg_parser';
-export type ChordsOverWordsParserOptions = ParseOptions & {
-    softLineBreaks?: boolean;
-    chopFirstWord?: boolean;
-};
-/**
- * Parses a chords over words sheet into a song
- *
- * It support "regular" chord sheets:
- *
- *            Am         C/G        F          C
- *     Let it be, let it be, let it be, let it be
- *     C                G              F  C/E Dm C
- *     Whisper words of wisdom, let it be
- *
- * Additionally, some chordpro features have been "ported back". For example, you can use chordpro directives:
- *
- *     {title: Let it be}
- *     {key: C}
- *     Chorus 1:
- *            Am
- *     Let it be
- *
- * For convenience, you can leave out the brackets:
- *
- *     title: Let it be
- *     Chorus 1:
- *            Am
- *     Let it be
- *
- * You can even use a markdown style frontmatter separator to separate the header from the song:
- *
- *     title: Let it be
- *     key: C
- *     ---
- *     Chorus 1:
- *            Am         C/G        F          C
- *     Let it be, let it be, let it be, let it be
- *     C                G              F  C/E Dm C
- *     Whisper words of wisdom, let it be
- *
- * `ChordsOverWordsParser` is the better version of `ChordSheetParser`, which is deprecated.
- */
-declare class ChordsOverWordsParser {
-    song?: Song;
-    /**
-     * All warnings raised during parsing the chord sheet
-     * @member
-     * @type {ParserWarning[]}
-     */
-    get warnings(): ParserWarning[];
-    /**
-     * Parses a chords over words sheet into a song
-     * @param {string} chordSheet the chords over words sheet
-     * @param {ChordsOverWordsParserOptions} options Parser options.
-     * @param {ChordsOverWordsParserOptions.softLineBreaks} options.softLineBreaks=false If true, a backslash
-     * followed by a space is treated as a soft line break
-     * @param {ChordsOverWordsParserOptions.chopFirstWord} options.chopFirstWord=true If true, only the first lyric
-     * word is paired with the chord, the rest of the lyric is put in a separate chord lyric pair
-     * @see https://peggyjs.org/documentation.html#using-the-parser
-     * @returns {Song} The parsed song
-     */
-    parse(chordSheet: string, options?: ChordsOverWordsParserOptions): Song;
-}
-export default ChordsOverWordsParser;

package/lib/pdf/parser/null_tracer.d.ts

@@ -1,4 +0,0 @@
-declare class NullTracer {
-    trace(): void;
-}
-export default NullTracer;

package/lib/pdf/parser/parser_helpers.d.ts

@@ -1,3 +0,0 @@
-export declare function isWideCharacter(ch: string): boolean;
-export declare function buildVisualColumnMap(lyricsLine: string): number[];
-export declare function chopFirstWord(string: string): (string | null)[];

package/lib/pdf/parser/parser_warning.d.ts

@@ -1,33 +0,0 @@
-/**
- * Represents a parser warning, currently only used by ChordProParser.
- */
-declare class ParserWarning {
-    /**
-     * The warning message
-     * @member
-     * @type {string}
-     */
-    message: string;
-    /**
-     * The chord sheet line number on which the warning occurred
-     * @member
-     * @type {number}
-     */
-    lineNumber: number | null;
-    /**
-     * The chord sheet column on which the warning occurred
-     * @member
-     * @type {number}
-     */
-    column: number | null;
-    /**
-     * @hideconstructor
-     */
-    constructor(message: string, lineNumber: number | null, column: number | null);
-    /**
-     * Returns a stringified version of the warning
-     * @returns {string} The string warning
-     */
-    toString(): string;
-}
-export default ParserWarning;

package/lib/pdf/parser/ultimate_guitar_parser.d.ts

@@ -1,46 +0,0 @@
-import ChordSheetParser from './chord_sheet_parser';
-/**
- * Parses an Ultimate Guitar chord sheet with metadata
- * Inherits from {@link ChordSheetParser}
- */
-declare class UltimateGuitarParser extends ChordSheetParser {
-    currentSectionType: string | null;
-    pendingRepeatNotation: string | null;
-    /**
-     * Instantiate a chord sheet parser
-     * @param {Object} [options={}] options
-     * @param {boolean} [options.preserveWhitespace=true] whether to preserve trailing whitespace for chords
-     */
-    constructor({ preserveWhitespace }?: {
-        preserveWhitespace?: boolean;
-    });
-    parseLine(line: string): void;
-    private parseRegularLine;
-    parseNonEmptyLine(line: string): void;
-    private parseChordLineWithNextLine;
-    private unreadLine;
-    private isNonLyricsLine;
-    private parseChordsOnly;
-    parseLyricsWithChords(chordsLine: string, lyricsLine: string): void;
-    processCharacters(chordsLine: string, lyricsLine: string): number;
-    addCharacter(chr: string, nextChar: string): void;
-    shouldAddCharacterToChords(nextChar: string): boolean;
-    ensureChordLyricsPairInitialized(): void;
-    private extractRepeatNotation;
-    private applyRepeatNotation;
-    parseUGMetadata(line: string): boolean;
-    private extractCapoValue;
-    parseVerseDirective(line: string): boolean;
-    parseChorusDirective(line: string): boolean;
-    parseBridgeDirective(line: string): boolean;
-    parsePartDirective(line: string): boolean;
-    parseMetadata(line: string): boolean;
-    isSectionEnd(): boolean;
-    endOfSong(): void;
-    startSection(sectionType: string, label: string): void;
-    endSection({ addNewLine }?: {
-        addNewLine?: boolean | undefined;
-    }): void;
-    startNewLine(): void;
-}
-export default UltimateGuitarParser;

package/lib/pdf/pdf.d.ts

@@ -1,2 +0,0 @@
-export { default as PdfFormatter } from './formatter/pdf_formatter';
-export { JsPdfMeasurer } from './layout/measurement';

package/lib/pdf/rendering/html/html_doc_wrapper.d.ts

@@ -1,82 +0,0 @@
-import { DomMeasurer } from '../../layout/measurement';
-import { FontConfiguration } from '../../formatter/configuration';
-declare type HTMLElement = any;
-/**
- * HtmlWrapper is responsible for managing the DOM elements for the chord sheet
- */
-declare class HtmlDocWrapper {
-    container: HTMLElement;
-    pages: HTMLElement[];
-    currentPage: number;
-    totalPages: number;
-    pageSize: {
-        width: number;
-        height: number;
-    };
-    measurer: DomMeasurer;
-    constructor(container: HTMLElement, pageSize: {
-        width: number;
-        height: number;
-    });
-    /**
-     * Creates a new page in the container
-     */
-    createPage(): HTMLElement;
-    get pageStyles(): Record<string, string>;
-    /**
-     * Creates a new page and advances to it
-     */
-    newPage(): void;
-    /**
-     * Sets the current page
-     */
-    setPage(pageNumber: number): void;
-    /**
-     * Gets the current page element
-     */
-    getCurrentPage(): HTMLElement;
-    /**
-     * Adds an element to the current page at the specified position
-     */
-    addElement(element: HTMLElement, x: number, y: number): void;
-    /**
-     * Gets text dimensions using the DOM measurer
-     */
-    getTextDimensions(text: string, font: FontConfiguration): {
-        w: number;
-        h: number;
-    };
-    /**
-     * Gets text width using the DOM measurer
-     */
-    getTextWidth(text: string, font: FontConfiguration): number;
-    /**
-     * Splits text to fit within a maximum width
-     */
-    splitTextToSize(text: string, maxWidth: number, font: FontConfiguration): string[];
-    /**
-     * Sets the font style (no-op in HTML renderer)
-     */
-    setFontStyle(_font: FontConfiguration): void;
-    /**
-     * Sets line style for drawing (no-op in HTML renderer)
-     */
-    setLineStyle(_style: any): void;
-    /**
-     * Resets line dash style (no-op in HTML renderer)
-     */
-    resetDash(): void;
-    /**
-     * Executes a callback for each page
-     */
-    eachPage(callback: (page: HTMLElement, index: number) => void): void;
-    /**
-     * Gets the container element
-     */
-    getContainer(): HTMLElement;
-    /**
-     * Clean up resources
-     */
-    dispose(): void;
-}
-export default HtmlDocWrapper;

package/lib/pdf/rendering/html/html_element_styler.d.ts

@@ -1,58 +0,0 @@
-import { FontConfiguration } from '../../formatter/configuration';
-import { PositionedElement } from '../renderer';
-declare type HTMLElement = any;
-declare type CSSStyleDeclaration = any;
-/**
- * Configuration for HTML element styling
- */
-export interface HtmlStylerConfig {
-    cssClassPrefix?: string;
-    cssClasses?: Record<string, string>;
-}
-/**
- * Handles styling of HTML elements for the positioned HTML renderer.
- * Extracted to improve modularity and reduce file size.
- */
-export declare class HtmlElementStyler {
-    private config;
-    constructor(config: HtmlStylerConfig);
-    /**
-     * Gets the CSS class prefix
-     */
-    get prefix(): string;
-    /**
-     * Applies styles to an HTML element based on its positioned element data
-     */
-    applyElementStyle(htmlElement: HTMLElement, element: PositionedElement): void;
-    /**
-     * Gets conditional CSS styles from font configuration
-     */
-    getConditionalStyles(style: FontConfiguration): Partial<CSSStyleDeclaration>;
-    /**
-     * Gets type-specific styles for different element types
-     */
-    getTypeSpecificStyles(element: PositionedElement): Partial<CSSStyleDeclaration>;
-    /**
-     * Gets chord-specific styles
-     */
-    chordStyles(element: PositionedElement): Partial<CSSStyleDeclaration>;
-    /**
-     * Applies font styles to an HTML element
-     */
-    applyFontStyle(element: HTMLElement, style: FontConfiguration): void;
-    /**
-     * Applies ellipsis styling to an element
-     */
-    applyEllipsisStyle(element: HTMLElement, width: number): void;
-    /**
-     * Creates a class name string with the configured prefix
-     */
-    createClassName(...classes: (string | undefined)[]): string;
-    /**
-     * Gets the custom CSS class for an element type if configured
-     */
-    getCustomClass(elementType: string): string | undefined;
-    private getNormalizedFontStyles;
-    private normalizeColor;
-}
-export default HtmlElementStyler;

package/lib/pdf/rendering/html/positioned_html_renderer.d.ts

@@ -1,85 +0,0 @@
-import Dimensions from '../../layout/engine/dimensions';
-import HtmlDocWrapper from './html_doc_wrapper';
-import Song from '../../chord_sheet/song';
-import { LineLayout, MeasuredItem } from '../../layout/engine';
-import Renderer, { ParagraphLayout } from '../renderer';
-import { FontConfiguration, MeasuredHtmlFormatterConfiguration } from '../../formatter/configuration';
-/**
- * HtmlRenderer renders a song as HTML with absolute positioning
- */
-declare class PositionedHtmlRenderer extends Renderer {
-    private configuration;
-    private currentLayoutFontStyle;
-    private currentLayoutSection;
-    private currentLayoutTextItem;
-    private currentLineStyle;
-    private _dimensions;
-    private _dimensionCacheKey;
-    private styler;
-    container: HTMLElement;
-    doc: HtmlDocWrapper;
-    /**
-     * Creates a new HtmlRenderer
-     */
-    constructor(song: Song, container: HTMLElement, configuration: MeasuredHtmlFormatterConfiguration);
-    getFontConfiguration(objectType: string): FontConfiguration;
-    getDocumentMetadata(): Record<string, any>;
-    getDoc(): HtmlDocWrapper;
-    getHTML(): HTMLElement;
-    dispose(): void;
-    protected initializeBackend(): void;
-    protected createNewPage(): void;
-    protected renderChordDiagrams(): void;
-    protected renderHeadersAndFooters(): void;
-    private renderLayoutForEachPage;
-    private resetLayoutRenderingState;
-    private createLayoutRenderer;
-    private createLayoutBackend;
-    private renderHtmlText;
-    private applyLayoutTextClasses;
-    private applyLayoutTextStyles;
-    private renderHtmlImage;
-    private renderHtmlLine;
-    protected renderParagraphs(paragraphLayouts: ParagraphLayout[]): void;
-    private renderParagraph;
-    private groupElementsByPageAndColumn;
-    protected renderLineItems(lines: LineLayout[]): void;
-    private renderSingleLine;
-    private getCurrentContext;
-    private handleColumnOverflow;
-    private renderLineContent;
-    private renderMeasuredItem;
-    private renderChordLyricsPairItem;
-    private renderTagItem;
-    private updatePosition;
-    protected addSectionLabel(label: string, x: number, y: number, options?: {
-        noUnderline?: boolean;
-    }): void;
-    protected addComment(comment: string, x: number, y: number, options?: {
-        noUnderline?: boolean;
-    }): void;
-    private addTextElementWithOptions;
-    protected measureText(text: string, font: FontConfiguration): {
-        width: number;
-        height: number;
-    };
-    protected calculateChordBaseline(yOffset: number, items: MeasuredItem[], chordText: string): number;
-    protected finalizeRendering(): void;
-    protected getConfiguration(): MeasuredHtmlFormatterConfiguration;
-    get dimensions(): Dimensions;
-    protected getDocPageSize(): {
-        width: number;
-        height: number;
-    };
-    private calculateBounds;
-    private createParagraphDiv;
-    private createElementGroupDiv;
-    private renderElementGroup;
-    private renderElement;
-    private drawElement;
-    private drawTextElement;
-    private buildDimensions;
-    private generateDimensionCacheKey;
-    protected getExtraMetadata(page: number, totalPages: number): Record<string, string | string[]>;
-}
-export default PositionedHtmlRenderer;

package/lib/pdf/rendering/pdf/js_pdf_renderer.d.ts

@@ -1,46 +0,0 @@
-import { Blob } from 'buffer';
-import Dimensions from '../../layout/engine/dimensions';
-import DocWrapper from '../../formatter/pdf_formatter/doc_wrapper';
-import Song from '../../chord_sheet/song';
-import { MeasuredItem } from '../../layout/engine';
-import { PdfConstructor } from '../../formatter/pdf_formatter/types';
-import Renderer from '../renderer';
-import { FontConfiguration, PDFFormatterConfiguration } from '../../formatter/configuration';
-declare class JsPdfRenderer extends Renderer {
-    private configuration;
-    private _dimensions;
-    private _dimensionCacheKey;
-    doc: DocWrapper;
-    constructor(song: Song, docConstructor: PdfConstructor, configuration: PDFFormatterConfiguration);
-    getFontConfiguration(objectType: string): FontConfiguration;
-    getDocumentMetadata(): Record<string, any>;
-    save(filename: string): void;
-    generatePDF(): Promise<Blob>;
-    getDoc(): DocWrapper;
-    protected initializeBackend(): void;
-    protected createNewPage(): void;
-    protected renderChordDiagrams(): void;
-    private createDiagramContext;
-    private createDiagramConfig;
-    protected renderHeadersAndFooters(): void;
-    private createLayoutRenderer;
-    private createLayoutBackend;
-    protected measureText(text: string, font: FontConfiguration): {
-        width: number;
-        height: number;
-    };
-    protected calculateChordBaseline(yOffset: number, items: MeasuredItem[], chordText: string): number;
-    protected finalizeRendering(): void;
-    protected getConfiguration(): PDFFormatterConfiguration;
-    protected get dimensions(): Dimensions;
-    protected getDocPageSize(): {
-        width: number;
-        height: number;
-    };
-    private drawElement;
-    private drawUnderlineIfNeeded;
-    private buildDimensions;
-    private generateDimensionCacheKey;
-    protected getExtraMetadata(page: number, totalPages: number): Record<string, string | string[]>;
-}
-export default JsPdfRenderer;

package/lib/pdf/rendering/pdf/pdf_chord_diagram_renderer.d.ts

@@ -1,118 +0,0 @@
-import DocWrapper from '../../formatter/pdf_formatter/doc_wrapper';
-import Song from '../../chord_sheet/song';
-import { ChordDiagramRenderingConfig } from '../../chord_diagram/chord_diagram';
-import { ChordDiagramFontConfigurations } from '../../formatter/configuration';
-/**
- * Context for chord diagram rendering
- */
-export interface ChordDiagramRenderingContext {
-    song: Song;
-    doc: DocWrapper;
-    getMinY: () => number;
-    getColumnStartX: () => number;
-    getColumnBottomY: () => number;
-    moveToNextColumn: () => void;
-    dimensions: {
-        columnWidth: number;
-    };
-    getX: () => number;
-    getY: () => number;
-    getCurrentColumn: () => number;
-    getCurrentPage: () => number;
-    setPosition: (x: number, y: number, column: number, page: number) => void;
-}
-/**
- * Configuration for chord diagram rendering
- */
-export interface ChordDiagramConfig {
-    enabled: boolean;
-    renderingConfig?: ChordDiagramRenderingConfig;
-    fonts: ChordDiagramFontConfigurations;
-    overrides?: {
-        global?: Record<string, {
-            hide?: boolean;
-            definition?: string;
-        }>;
-        byKey?: Record<string, Record<string, {
-            hide?: boolean;
-            definition?: string;
-        }>>;
-    };
-}
-/**
- * Handles chord diagram rendering for PDF output.
- * Extracted from JsPdfRenderer to improve modularity.
- */
-export declare class ChordDiagramRenderer {
-    private context;
-    private config;
-    constructor(context: ChordDiagramRenderingContext, config: ChordDiagramConfig);
-    /**
-     * Renders all chord diagrams for the song
-     */
-    render(): void;
-    /**
-     * Calculates layout dimensions for chord diagrams
-     */
-    private calculateDiagramLayout;
-    /**
-     * Initializes position for diagram rendering
-     */
-    private initializeDiagramPosition;
-    /**
-     * Renders a single chord diagram
-     */
-    private renderSingleChordDiagram;
-    /**
-     * Positions for the next diagram, handling row and column breaks
-     */
-    private positionForNextDiagram;
-    private getInitialPosition;
-    private handleRowBreak;
-    private handleColumnBreak;
-    /**
-     * Draws a single chord diagram
-     */
-    private drawChordDiagram;
-    /**
-     * Processes chord overrides from configuration
-     */
-    private processChordOverrides;
-    /**
-     * Extracts override values from configuration
-     */
-    private extractOverrideValues;
-    /**
-     * Gets chord definitions from the song
-     */
-    private getChordDefinitions;
-    /**
-     * Builds a chord diagram from a chord definition
-     */
-    private buildChordDiagram;
-    /**
-     * Processes fingering information and identifies barres
-     */
-    private processFingeringAndBarres;
-    /**
-     * Adds markers without fingering information
-     */
-    private addMarkersWithoutFingering;
-    /**
-     * Groups frets by finger for barre detection
-     */
-    private groupFretsByFinger;
-    /**
-     * Processes grouped frets/fingers into markers and barres
-     */
-    private processFretFingerGroups;
-    /**
-     * Processes a single finger group into either a marker or barre
-     */
-    private processFingerGroup;
-    /**
-     * Adds a barre if string positions are valid
-     */
-    private addBarreIfValid;
-}
-export default ChordDiagramRenderer;