chordsheetjs 15.0.0 → 15.0.1

package/lib/pdf/layout/engine/layout_helpers.d.ts

@@ -1,35 +0,0 @@
-import { LayoutConfig, LineLayout } from './types';
-/**
- * Create a column break line layout
- */
-export declare function createColumnBreakLineLayout(): LineLayout;
-/**
- * Calculate the total height of a set of line layouts
- */
-export declare function calculateTotalHeight(lineLayouts: LineLayout[][]): number;
-/**
- * Check if a line layout represents a column break
- */
-export declare function isColumnBreakLayout(lineLayout: LineLayout[]): boolean;
-/**
- * Update the position based on layout content
- */
-export declare function updatePosition(layout: LineLayout[], currentY: number, currentColumn: number, config: LayoutConfig): {
-    newY: number;
-    newColumn: number;
-};
-/**
- * Count different types of lines within layouts
- */
-export declare function countLineTypes(lineLayouts: LineLayout[][]): {
-    chordLyricPairLines: number;
-    commentLines: number;
-    sectionLabelLines: number;
-    tagLines: number;
-    emptyLines: number;
-    nonLyricLines: number;
-};
-/**
- * Determine if a paragraph should be skipped in lyrics-only mode
- */
-export declare function shouldSkipParagraph(lineLayouts: LineLayout[][], lyricsOnly?: boolean): boolean;

package/lib/pdf/layout/engine/line_breaker.d.ts

@@ -1,54 +0,0 @@
-import { ItemProcessor } from './item_processor';
-import { LayoutFactory } from './layout_factory';
-import Line from '../../chord_sheet/line';
-import { LineLayout } from './types';
-/**
- * Handles breaking lines into layouts based on available width
- */
-export declare class LineBreaker {
-    private readonly itemProcessor;
-    private readonly layoutFactory;
-    constructor(itemProcessor: ItemProcessor, layoutFactory: LayoutFactory);
-    /**
-     * Break a line into layouts that fit within the available width
-     */
-    breakLineIntoLayouts(line: Line, availableWidth: number, lyricsOnly?: boolean): LineLayout[];
-    /**
-     * Recursively break content into layouts that fit within the available width
-     */
-    private breakContent;
-    /**
-     * Handle content with no soft breaks
-     */
-    private handleNoSoftBreaks;
-    /**
-     * Consolidate consecutive soft line breaks into single breaks
-     */
-    private consolidateConsecutiveSoftBreaks;
-    private skipConsecutiveSoftBreaks;
-    private findBreakIndex;
-    private handleOversizedFirstItem;
-    private analyzeContent;
-    private shouldReturnSingleLayout;
-    private splitAtBestSoftBreak;
-    private removeTrailingComma;
-    /**
-     * Calculate the total width of items up to (but not including) the given index
-     */
-    private getWidthUpToIndex;
-    /**
-     * Remeasure the width of lyrics after modification
-     */
-    private remeasureLyrics;
-    /**
-     * Recalculate the full chord-lyric pair width (similar to ItemProcessor logic)
-     */
-    private recalculateChordLyricWidth;
-    private measureChordAndLyricWidths;
-    private adjustChordWidth;
-    private shouldSkipChordSpacing;
-    /**
-     * Capitalize the first letter of the next item with lyrics
-     */
-    private capitalizeNextItem;
-}

package/lib/pdf/layout/engine/paragraph_splitter/index.d.ts

@@ -1,5 +0,0 @@
-export { ParagraphSplitter } from './paragraph_splitter';
-export { ParagraphSplitStrategy } from '../types';
-export { ThreeOrLessLinesParagraphSplitStrategy } from './strategies/three_or_less_lines_paragraph_split_strategy';
-export { FourLinesParagraphSplitStrategy } from './strategies/four_lines_paragraph_split_strategy';
-export { FiveOrMoreLinesParagraphSplitStrategy } from './strategies/five_or_more_lines_paragraph_split_strategy';

package/lib/pdf/layout/engine/paragraph_splitter/paragraph_splitter.d.ts

@@ -1,5 +0,0 @@
-import { LineLayout } from '../types';
-export declare class ParagraphSplitter {
-    splitParagraph(lineLayouts: LineLayout[][], currentY: number, columnStartY: number, columnBottomY: number, chordLyricLineCount: number): LineLayout[][];
-    private createStrategy;
-}

package/lib/pdf/layout/engine/paragraph_splitter/strategies/five_or_more_lines_paragraph_split_strategy.d.ts

@@ -1,14 +0,0 @@
-import { LineLayout, ParagraphSplitStrategy } from '../../types';
-export declare class FiveOrMoreLinesParagraphSplitStrategy implements ParagraphSplitStrategy {
-    private chordLyricLineCount;
-    private totalChordLyricPairLines;
-    constructor(chordLyricLineCount: number);
-    splitParagraph(lineLayouts: LineLayout[][], currentY: number, columnStartY: number, columnBottomY: number): LineLayout[][];
-    private trySplitParagraph;
-    private selectSplit;
-    private buildSplitResult;
-    private flattenLineLayouts;
-    private findAcceptableSplits;
-    private partitionLineLayouts;
-    private partitionReducer;
-}

package/lib/pdf/layout/engine/paragraph_splitter/strategies/four_lines_paragraph_split_strategy.d.ts

@@ -1,8 +0,0 @@
-import { LineLayout, ParagraphSplitStrategy } from '../../types';
-export declare class FourLinesParagraphSplitStrategy implements ParagraphSplitStrategy {
-    splitParagraph(lineLayouts: LineLayout[][], currentY: number, columnStartY: number, columnBottomY: number): LineLayout[][];
-    private findSplitMetadata;
-    private summarizeLineLayout;
-    private buildSplitResult;
-    private prependColumnBreakIfNeeded;
-}

package/lib/pdf/layout/engine/paragraph_splitter/strategies/three_or_less_lines_paragraph_split_strategy.d.ts

@@ -1,4 +0,0 @@
-import { LineLayout, ParagraphSplitStrategy } from '../../types';
-export declare class ThreeOrLessLinesParagraphSplitStrategy implements ParagraphSplitStrategy {
-    splitParagraph(lineLayouts: LineLayout[][], currentY: number, columnStartY: number, columnBottomY: number): LineLayout[][];
-}

package/lib/pdf/layout/engine/title_separator_tag.d.ts

@@ -1,8 +0,0 @@
-import Tag from '../../chord_sheet/tag';
-declare class TitleSeparatorTag extends Tag {
-    constructor();
-    get value(): string;
-    set value(newValue: string);
-    clone(): Tag;
-}
-export default TitleSeparatorTag;

package/lib/pdf/layout/engine/types.d.ts

@@ -1,98 +0,0 @@
-import ChordLyricsPair from '../../chord_sheet/chord_lyrics_pair';
-import { FontConfiguration } from '../../formatter/configuration';
-import Line from '../../chord_sheet/line';
-import SoftLineBreak from '../../chord_sheet/soft_line_break';
-import Tag from '../../chord_sheet/tag';
-export interface Measurer {
-    measureTextWidth(text: string, font: {
-        size: number;
-        lineHeight?: number;
-    }): number;
-    measureTextHeight(text: string, font: {
-        size: number;
-        lineHeight?: number;
-    }): number;
-    splitTextToSize(text: string, maxWidth: number, font: {
-        size: number;
-        lineHeight?: number;
-    }): string[];
-}
-/**
- * Represents a break point in text for line wrapping
- */
-export interface BreakPoint {
-    index: number;
-    type: 'space' | 'hyphen' | 'comma' | 'other';
-}
-/**
- * Represents a measured chord-lyrics pair with position information
- */
-export interface MeasuredItem {
-    item: ChordLyricsPair | Tag | SoftLineBreak | null;
-    width: number;
-    chordHeight?: number;
-    chordLyricWidthDifference?: number;
-}
-/**
- * Represents a single line in the layout
- */
-export interface LineLayout {
-    type: 'ChordLyricsPair' | 'Comment' | 'SectionLabel' | 'Tag' | 'Empty';
-    lineHeight: number;
-    items: MeasuredItem[];
-    line: Line;
-}
-/**
- * Represents a paragraph in the layout
- */
-/**
- * Complete layout for a song
- */
-/**
- * Configuration for the layout engine
- */
-export interface LayoutConfig {
-    width: number;
-    fonts: {
-        chord: FontConfiguration;
-        lyrics: FontConfiguration;
-        comment: FontConfiguration;
-        sectionLabel: FontConfiguration;
-    };
-    chordSpacing: number;
-    chordLyricSpacing: number;
-    linePadding: number;
-    useUnicodeModifiers: boolean;
-    normalizeChords: boolean;
-    minY: number;
-    columnWidth: number;
-    columnCount?: number;
-    columnSpacing: number;
-    minColumnWidth?: number;
-    maxColumnWidth?: number;
-    paragraphSpacing: number;
-    columnBottomY: number;
-    displayLyricsOnly?: boolean;
-    decapo: boolean;
-    repeatedSections?: 'hide' | 'title_only' | 'lyrics_only' | 'full';
-}
-export interface ParagraphLayoutResult {
-    units: LineLayout[][];
-    addSpacing: boolean;
-    sectionType: string;
-}
-/**
- * Strategy interface for paragraph splitting
- */
-export interface ParagraphSplitStrategy {
-    /**
-     * Split a paragraph into parts that fit within column constraints
-     *
-     * @param lineLayouts - The layout of the paragraph to split
-     * @param currentY - Current vertical position in the column
-     * @param columnStartY - The starting Y position of columns
-     * @param columnBottomY - The bottom Y position of columns
-     * @returns The layout with column breaks inserted as needed
-     */
-    splitParagraph(lineLayouts: LineLayout[][], currentY: number, columnStartY: number, columnBottomY: number): LineLayout[][];
-}

package/lib/pdf/layout/measurement/canvas_measurer.d.ts

@@ -1,18 +0,0 @@
-import { FontConfiguration } from '../../formatter/configuration';
-import { BaseMeasurer, TextDimensions } from './measurer';
-/**
- * Measures text using Canvas API
- */
-export declare class CanvasMeasurer extends BaseMeasurer {
-    private canvas;
-    private context;
-    constructor();
-    /**
-     * Sets font configuration on the canvas context
-     * @param fontConfig The font configuration to apply
-     */
-    private setFont;
-    measureText(text: string, fontConfig: FontConfiguration): TextDimensions;
-    splitTextToSize(text: string, maxWidth: number, fontConfig: FontConfiguration): string[];
-    private measureWidth;
-}

package/lib/pdf/layout/measurement/dom_measurer.d.ts

@@ -1,21 +0,0 @@
-import { FontConfiguration } from '../../formatter/configuration';
-import { BaseMeasurer, TextDimensions } from './measurer';
-/**
- * Measures text using DOM elements
- */
-export declare class DomMeasurer extends BaseMeasurer {
-    private measureElement;
-    constructor();
-    /**
-     * Cleans up the DOM element when no longer needed
-     */
-    dispose(): void;
-    /**
-     * Sets font configuration on the measurement element
-     * @param fontConfig The font configuration to apply
-     */
-    private setFont;
-    measureText(text: string, fontConfig: FontConfiguration): TextDimensions;
-    splitTextToSize(text: string, maxWidth: number, fontConfig: FontConfiguration): string[];
-    private measureWidth;
-}

package/lib/pdf/layout/measurement/index.d.ts

@@ -1,4 +0,0 @@
-export * from './measurer';
-export * from './js_pdf_measurer';
-export * from './canvas_measurer';
-export * from './dom_measurer';

package/lib/pdf/layout/measurement/js_pdf_measurer.d.ts

@@ -1,12 +0,0 @@
-import DocWrapper from '../../formatter/pdf_formatter/doc_wrapper';
-import { FontConfiguration } from '../../formatter/configuration';
-import { BaseMeasurer, TextDimensions } from './measurer';
-/**
- * Measures text using jsPDF
- */
-export declare class JsPdfMeasurer extends BaseMeasurer {
-    private doc;
-    constructor(doc: DocWrapper);
-    measureText(text: string, fontConfig: FontConfiguration): TextDimensions;
-    splitTextToSize(text: string, maxWidth: number, fontConfig: FontConfiguration): string[];
-}

package/lib/pdf/layout/measurement/measurer.d.ts

@@ -1,52 +0,0 @@
-import { FontConfiguration } from '../../formatter/configuration';
-export interface TextDimensions {
-    width: number;
-    height: number;
-}
-export interface Measurer {
-    /**
-     * Measures the dimensions of text with the given font configuration
-     * @param text The text to measure
-     * @param fontConfig The font configuration to apply
-     * @returns The dimensions of the text
-     */
-    measureText(text: string, fontConfig: FontConfiguration): TextDimensions;
-    /**
-     * Measures the width of text with the given font configuration
-     * @param text The text to measure
-     * @param fontConfig The font configuration to apply
-     * @returns The width of the text
-     */
-    measureTextWidth(text: string, fontConfig: FontConfiguration): number;
-    /**
-     * Measures the height of text with the given font configuration
-     * @param text The text to measure
-     * @param fontConfig The font configuration to apply
-     * @returns The height of the text
-     */
-    measureTextHeight(text: string, fontConfig: FontConfiguration): number;
-    /**
-     * Splits text into lines that fit within the given width
-     * @param text The text to split
-     * @param maxWidth The maximum width of each line
-     * @param fontConfig The font configuration to apply
-     * @returns The lines of text
-     */
-    splitTextToSize(text: string, maxWidth: number, fontConfig: FontConfiguration): string[];
-}
-/**
- * Base class for implementing measurers with common functionality
- */
-export declare abstract class BaseMeasurer implements Measurer {
-    abstract measureText(text: string, fontConfig: FontConfiguration): TextDimensions;
-    measureTextWidth(text: string, fontConfig: FontConfiguration): number;
-    measureTextHeight(text: string, fontConfig: FontConfiguration): number;
-    abstract splitTextToSize(text: string, maxWidth: number, fontConfig: FontConfiguration): string[];
-    protected splitTextWithMeasure(text: string, maxWidth: number, measure: (value: string) => number): string[];
-    protected wrapParagraph(paragraph: string, maxWidth: number, measure: (value: string) => number): string[];
-    protected splitWord(word: string, maxWidth: number, measure: (value: string) => number): {
-        lines: string[];
-        remainder: string;
-    };
-    private accumulateWords;
-}

package/lib/pdf/normalize_mappings/enharmonic-normalize.d.ts

@@ -1,2 +0,0 @@
-declare const enharmonics: Record<string, Record<string, string>>;
-export default enharmonics;

package/lib/pdf/normalize_mappings/suffix-normalize-mapping.d.ts

@@ -1,2 +0,0 @@
-declare const mapping: Record<string, string>;
-export default mapping;

package/lib/pdf/pango/pango_helpers.d.ts

@@ -1,6 +0,0 @@
-export declare function stripPangoMarkup(text: string): string;
-export interface PangoRenderer {
-    convert(text: string): string;
-}
-export declare function pangoToHtml(text: string): string;
-export declare const defaultPangoRenderer: PangoRenderer;

package/lib/pdf/parser/chord/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/chord_definition/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/chord_pro/helpers.d.ts

@@ -1,15 +0,0 @@
-import { SerializedChordLyricsPair, SerializedItem, SerializedLine, SerializedSoftLineBreak, SerializedTag } from '../../serialized_types';
-import { FileRange } from './peg_parser';
-export declare function buildLine(items: any[]): SerializedLine;
-export declare function buildSection(startTag: SerializedTag, endTag: SerializedTag, content: string): SerializedLine[];
-export declare function buildTag(name: string, value: Partial<{
-    value: string | null;
-    attributes: Record<string, string>;
-}> | null, selector: {
-    value: string | null;
-    isNegated: boolean;
-} | null, location: FileRange): SerializedTag;
-export declare function stringSplitReplace(string: string, search: string, replaceMatch: (subString: string) => any, replaceRest?: (subString: string) => any): any[];
-export declare function applySoftLineBreaks(lyrics: string): SerializedChordLyricsPair[];
-export declare function breakChordLyricsPairOnSoftLineBreak(chords: string, lyrics: string): (SerializedChordLyricsPair | SerializedSoftLineBreak)[];
-export declare function combineChordLyricsPairs(items: SerializedItem[], chopFirstWord?: boolean): SerializedItem[];

package/lib/pdf/parser/chord_pro/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/chord_pro_parser.d.ts

@@ -1,32 +0,0 @@
-import ParserWarning from './parser_warning';
-import Song from '../chord_sheet/song';
-import { ParseOptions } from './chord_pro/peg_parser';
-export type ChordProParserOptions = ParseOptions & {
-    softLineBreaks?: boolean;
-    chopFirstWord?: boolean;
-};
-/**
- * Parses a ChordPro chord sheet
- */
-declare class ChordProParser {
-    song?: Song;
-    /**
-     * All warnings raised during parsing the chord sheet
-     * @member
-     * @type {ParserWarning[]}
-     */
-    get warnings(): ParserWarning[];
-    /**
-     * Parses a ChordPro chord sheet into a song
-     * @param {string} chordSheet the ChordPro chord sheet
-     * @param {ChordProParserOptions} options Parser options.
-     * @param {ChordProParserOptions.softLineBreaks} options.softLineBreaks=false If true, a backslash
-     * followed by * a space is treated as a soft line break
-     * @param {ChordProParserOptions.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?: ChordProParserOptions): Song;
-}
-export default ChordProParser;

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

@@ -1,57 +0,0 @@
-import ChordLyricsPair from '../chord_sheet/chord_lyrics_pair';
-import Line from '../chord_sheet/line';
-import Song from '../chord_sheet/song';
-import SongBuilder from '../song_builder';
-/**
- * Parses a normal chord sheet
- *
- * ChordSheetParser is deprecated, please use ChordsOverWordsParser.
- *
- * ChordsOverWordsParser aims to support any kind of chord, whereas ChordSheetParser lacks
- * support for many variations. Besides that, some chordpro feature have been ported back
- * to ChordsOverWordsParser, which adds some interesting functionality.
- */
-declare class ChordSheetParser {
-    processingText: boolean;
-    preserveWhitespace: boolean;
-    song: Song;
-    songBuilder: SongBuilder;
-    songLine: Line | null;
-    chordLyricsPair: ChordLyricsPair | null;
-    lines: string[];
-    currentLine: number;
-    lineCount: number;
-    /**
-     * Instantiate a chord sheet parser
-     * ChordSheetParser is deprecated, please use ChordsOverWordsParser.
-     * @param {Object} [options={}] options
-     * @param {boolean} [options.preserveWhitespace=true] whether to preserve trailing whitespace for chords
-     * @deprecated
-     */
-    constructor({ preserveWhitespace }?: {
-        preserveWhitespace?: boolean;
-    }, showDeprecationWarning?: boolean);
-    /**
-     * Parses a chord sheet into a song
-     * @param {string} chordSheet The ChordPro chord sheet
-     * @param {Object} [options={}] Optional parser options
-     * @param {Song} [options.song=null] The {@link Song} to store the song data in
-     * @returns {Song} The parsed song
-     */
-    parse(chordSheet: string, { song }?: {
-        song?: Song;
-    }): Song;
-    endOfSong(): void;
-    parseLine(line: any): void;
-    parseNonEmptyLine(line: any): void;
-    initialize(document: any, song?: Song | null): void;
-    readLine(): string;
-    hasNextLine(): boolean;
-    parseLyricsWithChords(chordsLine: any, lyricsLine: any): void;
-    processCharacters(chordsLine: any, lyricsLine: any): number;
-    mapLyricsCharacter(columnMap: number[], column: number, lyricsLine: string, lastIndex: number): number;
-    addCharacter(chr: any, nextChar: any): void;
-    shouldAddCharacterToChords(nextChar: any): any;
-    ensureChordLyricsPairInitialized(): void;
-}
-export default ChordSheetParser;