chordsheetjs 15.0.0 → 15.1.0

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

@@ -1,273 +0,0 @@
-import Dimensions from '../layout/engine/dimensions';
-import Line from '../chord_sheet/line';
-import Song from '../chord_sheet/song';
-import { LineLayout, MeasuredItem } from '../layout/engine';
-import { FontConfiguration, LayoutItem, MeasurementBasedFormatterConfiguration } from '../formatter/configuration';
-/**
- * Interface representing paragraph layouts from the layout engine
- */
-export interface ParagraphLayout {
-    units: LineLayout[][];
-    addSpacing: boolean;
-    sectionType: string;
-}
-/**
- * PositionedElement represents an element with absolute positioning
- */
-export interface PositionedElement {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    content: any;
-    type: string;
-    style?: any;
-    page: number;
-    column: number;
-}
-/**
- * Abstract renderer class for absolute-positioned rendering
- */
-declare abstract class Renderer {
-    protected song: Song;
-    protected startTime: number;
-    protected renderTime: number;
-    protected x: number;
-    protected y: number;
-    protected currentColumn: number;
-    protected elements: PositionedElement[];
-    protected currentPage: number;
-    constructor(song: Song);
-    /**
-     * Initialize the renderer with the song
-     */
-    initialize(): void;
-    /**
-     * Main render method - the only method that formatters should call
-     * @param paragraphLayouts The layouts to render
-     * @param config Additional configuration options
-     */
-    render(paragraphLayouts: ParagraphLayout[], _config?: any): void;
-    /**
-     * Get the bottom Y position available for content
-     */
-    getContentBottomY(): number;
-    /**
-     * Get metadata about the rendered document
-     */
-    abstract getDocumentMetadata(): Record<string, any>;
-    /**
-     * Get the font configuration for a specific object type
-     */
-    abstract getFontConfiguration(objectType: string): FontConfiguration;
-    /**
-     * Get the current rendering time in seconds
-     */
-    getRenderTime(): number;
-    /**
-     * Renders all paragraph layouts
-     */
-    protected renderParagraphs(paragraphLayouts: ParagraphLayout[]): void;
-    /**
-     * Render lines of content with chords, lyrics, and other elements
-     */
-    protected renderLines(lines: LineLayout[]): void;
-    private renderLineLayout;
-    protected hasColumnBreak(lineLayout: LineLayout): boolean;
-    private renderItem;
-    private renderChordLyricsPair;
-    /**
-     * Move to the next column or page
-     */
-    protected moveToNextColumn(): void;
-    /**
-     * Start a new page
-     */
-    protected startNewPage(): void;
-    /**
-     * Calculate chord and lyrics Y offsets based on the line content
-     */
-    protected calculateChordLyricYOffsets(items: MeasuredItem[], yOffset: number): {
-        chordsYOffset: number;
-        lyricsYOffset: number;
-    };
-    /**
-     * Get the maximum chord height for a line
-     */
-    protected getMaxChordHeight(items: MeasuredItem[]): number;
-    /**
-     * Process chords for display (handle modifiers, normalization)
-     */
-    protected processChords(chords: string, line: Line): string;
-    /**
-     * Add a text element to the elements array
-     */
-    protected addTextElement(text: string, x: number, y: number, type: string): void;
-    /**
-     * Add a section label element
-     */
-    protected addSectionLabel(label: string, x: number, y: number): void;
-    /**
-     * Add a comment element
-     */
-    protected addComment(comment: string, x: number, y: number): void;
-    /**
-     * Get the font configuration for a specific element type
-     */
-    protected getFontForType(type: string): FontConfiguration;
-    /**
-     * Get the total number of pages in the document
-     */
-    protected getTotalPages(): number;
-    /**
-     * Get the starting X position for the current column
-     */
-    protected getColumnStartX(): number;
-    /**
-     * Get the bottom Y position for the current column
-     */
-    protected getColumnBottomY(): number;
-    /**
-     * Get the width of a column
-     */
-    protected getColumnWidth(): number;
-    /**
-     * Get the minimum X coordinate (left margin)
-     */
-    protected getMinX(): number;
-    /**
-     * Get the minimum Y coordinate (top margin + header)
-     */
-    protected getMinY(): number;
-    /**
-     * Record the rendering time
-     */
-    protected recordRenderingTime(): void;
-    /**
-     * Get the elements for a specific page
-     */
-    protected getElementsForPage(page: number): PositionedElement[];
-    /**
-     * Initialize the backend rendering system
-     */
-    protected abstract initializeBackend(): void;
-    /**
-     * Create a new page in the backend
-     */
-    protected abstract createNewPage(): void;
-    /**
-     * Render chord diagrams
-     */
-    protected abstract renderChordDiagrams(): void;
-    /**
-     * Render headers and footers
-     */
-    protected abstract renderHeadersAndFooters(): void;
-    /**
-     * Measure text with the given font
-     */
-    protected abstract measureText(text: string, font: FontConfiguration): {
-        width: number;
-        height: number;
-    };
-    /**
-     * Calculate chord baseline position
-     */
-    protected abstract calculateChordBaseline(yOffset: number, items: MeasuredItem[], chordText: string): number;
-    /**
-     * Finalize the rendering process
-     */
-    protected abstract finalizeRendering(): void;
-    /**
-     * Get the renderer configuration
-     */
-    protected abstract getConfiguration(): MeasurementBasedFormatterConfiguration | any;
-    /**
-     * Get the dimensions object for layout calculations
-     */
-    protected abstract get dimensions(): Dimensions;
-    /**
-     * Get the page size from the document wrapper
-     */
-    protected abstract getDocPageSize(): {
-        width: number;
-        height: number;
-    };
-    /**
-     * Get the layout configuration
-     */
-    protected getLayout(): MeasurementBasedFormatterConfiguration['layout'];
-    /**
-     * Get the header configuration
-     */
-    protected getHeaderConfig(): LayoutItem | undefined;
-    /**
-     * Get the footer configuration
-     */
-    protected getFooterConfig(): LayoutItem | undefined;
-    /**
-     * Get the page width
-     */
-    protected getPageWidth(): number;
-    /**
-     * Get the page height
-     */
-    protected getPageHeight(): number;
-    /**
-     * Get the left margin
-     */
-    protected getLeftMargin(): number;
-    /**
-     * Get the right margin
-     */
-    protected getRightMargin(): number;
-    /**
-     * Get the top margin
-     */
-    protected getTopMargin(): number;
-    /**
-     * Get the bottom margin
-     */
-    protected getBottomMargin(): number;
-    /**
-     * Get the header height
-     */
-    protected getHeaderHeight(): number;
-    /**
-     * Get the footer height
-     */
-    protected getFooterHeight(): number;
-    /**
-     * Get the column count
-     */
-    protected getColumnCount(): number;
-    /**
-     * Get the sections configuration with defaults
-     */
-    protected getSectionsConfig(): import("../formatter/configuration").SectionsConfig;
-    /**
-     * Get the column spacing
-     */
-    protected getColumnSpacing(): number;
-    /**
-     * Get the chord-to-lyrics spacing
-     */
-    protected getChordLyricSpacing(): number;
-    /**
-     * Get the paragraph spacing
-     */
-    protected getParagraphSpacing(): number;
-    /**
-     * Whether to use Unicode modifiers for chord rendering
-     */
-    protected useUnicodeModifiers(): boolean;
-    /**
-     * Whether to normalize chords
-     */
-    protected normalizeChords(): boolean;
-    /**
-     * Whether to render lyrics only (no chords)
-     */
-    protected isLyricsOnly(): boolean;
-}
-export default Renderer;

package/lib/pdf/rendering/shared/layout_section_renderer.d.ts

@@ -1,93 +0,0 @@
-import type { ImageCompression } from 'jspdf';
-import Metadata from '../../chord_sheet/metadata';
-import { Alignment, FontConfiguration, LayoutContentItemWithText, LayoutItem, LayoutSection, Margins } from '../../formatter/configuration';
-/**
- * Backend abstraction for layout rendering operations.
- * Both PDF and HTML renderers implement this interface.
- */
-export interface LayoutRenderingBackend {
-    pageSize: {
-        width: number;
-        height: number;
-    };
-    currentPage: number;
-    totalPages: number;
-    text(content: string, x: number, y: number): void;
-    getTextWidth(text: string, font?: FontConfiguration): number;
-    splitTextToSize(text: string, maxWidth: number, font?: FontConfiguration): string[];
-    setFontStyle(style: FontConfiguration): void;
-    setTextItem?(item: LayoutContentItemWithText): void;
-    addElement?(element: any, x: number, y: number): void;
-    addImage(src: string, format: string, x: number, y: number, width: number, height: number, alias?: string, compression?: ImageCompression, rotation?: number): void;
-    line(x1: number, y1: number, x2: number, y2: number): void;
-    setLineStyle(style: any): void;
-    resetDash(): void;
-    setDrawColor?(color: number): void;
-    setLineWidth?(width: number): void;
-}
-/**
- * Context for rendering layout sections (headers/footers)
- */
-export interface LayoutRenderingContext {
-    metadata: Metadata;
-    margins: Margins;
-    extraMetadata: Record<string, string | string[]>;
-}
-/**
- * Renders layout sections (headers and footers) for both PDF and HTML backends.
- * This extracts the common layout rendering logic that was duplicated across renderers.
- */
-export declare class LayoutSectionRenderer {
-    private backend;
-    private context;
-    constructor(backend: LayoutRenderingBackend, context: LayoutRenderingContext);
-    /**
-     * Renders a layout section (header or footer)
-     */
-    renderLayout(layoutConfig: LayoutItem, section: LayoutSection): void;
-    /**
-     * Determines if a content item should be rendered based on conditions
-     */
-    private shouldRenderContent;
-    /**
-     * Renders a text item
-     */
-    private renderTextItem;
-    /**
-     * Renders clipped text with optional ellipsis
-     */
-    private renderClippedText;
-    /**
-     * Clips text with ellipsis if it exceeds the maximum width
-     */
-    private clipTextWithEllipsis;
-    /**
-     * Clips text to fit within the maximum width
-     */
-    clipText(text: string, maxWidth: number, style?: FontConfiguration): string;
-    /**
-     * Renders multiline text
-     */
-    private renderMultilineText;
-    /**
-     * Renders an image
-     */
-    private renderImage;
-    /**
-     * Renders a line
-     */
-    private renderLine;
-    /**
-     * Evaluates a template with metadata
-     */
-    private evaluateTemplate;
-    /**
-     * Calculates the X position based on alignment
-     */
-    calculateX(alignment: Alignment | number, width?: number, offsetX?: number): number;
-    /**
-     * Gets the available width for content
-     */
-    private getAvailableWidth;
-}
-export default LayoutSectionRenderer;

package/lib/pdf/scales.d.ts

@@ -1,3 +0,0 @@
-import { ChordType, Mode, ModifierMaybe } from './constants';
-export declare const KEY_TO_GRADE: Record<ChordType, Record<Mode, Record<ModifierMaybe, Record<string, number>>>>;
-export declare const GRADE_TO_KEY: Record<ChordType, Record<Mode, Record<ModifierMaybe, Record<number, string>>>>;

package/lib/pdf/serialized_types.d.ts

@@ -1,76 +0,0 @@
-import { Accidental, ChordType, Fret } from './constants';
-export interface SerializedTraceInfo {
-    location?: {
-        offset: number | null;
-        line: number | null;
-        column: number | null;
-    };
-}
-export interface SerializedChord {
-    type: 'chord';
-    base: string;
-    accidental: Accidental | null;
-    suffix: string | null;
-    bassBase: string | null;
-    bassAccidental: Accidental | null;
-    chordType: ChordType;
-    optional?: boolean;
-}
-export interface SerializedChordLyricsPair {
-    type: 'chordLyricsPair';
-    chord?: SerializedChord | null;
-    chords: string;
-    lyrics: string | null;
-    annotation?: string | null;
-    isRhythmSymbol?: boolean;
-}
-export interface SerializedChordDefinition {
-    name: string;
-    baseFret: number;
-    frets: Fret[];
-    fingers?: number[];
-}
-export type SerializedTag = SerializedTraceInfo & {
-    type: 'tag';
-    name: string;
-    value: string;
-    chordDefinition?: SerializedChordDefinition;
-    attributes?: Record<string, string>;
-    selector?: string | null;
-    isNegated?: boolean;
-};
-export interface SerializedComment {
-    type: 'comment';
-    comment: string;
-}
-export type ContentType = 'tab' | 'abc' | 'ly' | 'svg' | 'grid' | 'textblock';
-export type PartTypes = 'part' | 'intro' | 'instrumental' | 'tag' | 'end';
-export interface SerializedSection {
-    type: 'section';
-    sectionType: ContentType;
-    content: string[];
-    startTag: SerializedTag;
-    endTag: SerializedTag;
-}
-export type SerializedLiteral = string;
-export interface SerializedTernary extends SerializedTraceInfo {
-    type: 'ternary';
-    variable: string | null;
-    valueTest: string | null;
-    trueExpression: (SerializedLiteral | SerializedTernary)[];
-    falseExpression: (SerializedLiteral | SerializedTernary)[];
-}
-export type SerializedComposite = (SerializedLiteral | SerializedTernary)[];
-export interface SerializedSoftLineBreak {
-    type: 'softLineBreak';
-}
-export type SerializedItem = SerializedChordLyricsPair | SerializedComment | SerializedLiteral | SerializedSoftLineBreak | SerializedTag | SerializedTernary;
-export interface SerializedLine {
-    type: 'line';
-    items: SerializedItem[];
-}
-export interface SerializedSong {
-    type: 'chordSheet';
-    lines: SerializedLine[];
-}
-export type SerializedComponent = SerializedLine | SerializedSong | SerializedChordLyricsPair | SerializedTag | SerializedComment | SerializedTernary | SerializedLiteral | SerializedSection | SerializedSoftLineBreak;

package/lib/pdf/song_builder.d.ts

@@ -1,38 +0,0 @@
-import FontStack from './chord_sheet/font_stack';
-import Item from './chord_sheet/item';
-import Metadata from './chord_sheet/metadata';
-import ParserWarning from './parser/parser_warning';
-import Song from './chord_sheet/song';
-import Tag from './chord_sheet/tag';
-import TraceInfo from './chord_sheet/trace_info';
-import Line from './chord_sheet/line';
-declare class SongBuilder {
-    currentKey: string | null;
-    currentLine: Line | null;
-    fontStack: FontStack;
-    lines: Line[];
-    metadata: Metadata;
-    sectionType: string;
-    selector: string | null;
-    selectorIsNegated: boolean;
-    song: Song;
-    transposeKey: string | null;
-    warnings: ParserWarning[];
-    constructor(song: Song);
-    get previousLine(): Line | null;
-    addLine(line?: Line): Line;
-    setCurrentProperties(sectionType: string, selector?: string | null, isNegated?: boolean): void;
-    addItem(item: Item): void;
-    chords(chr: string): void;
-    lyrics(chr: string): void;
-    addTag(tagContents: string | Tag): Tag;
-    ensureLine(): void;
-    private applyTagOnSong;
-    private applyTagOnLine;
-    setSectionTypeFromTag(tag: Tag): void;
-    startSection(sectionType: string, tag: Tag): void;
-    endSection(sectionType: string, tag: Tag): void;
-    checkCurrentSectionType(sectionType: string, tag: Tag): void;
-    addWarning(message: string, { line, column }: TraceInfo): void;
-}
-export default SongBuilder;

package/lib/pdf/template_helpers/metadata_processor.d.ts

@@ -1,14 +0,0 @@
-import { MetadataConfiguration } from '../formatter/configuration';
-declare class MetadataProcessor {
-    metadata: Record<string, string | string[]>;
-    config: MetadataConfiguration;
-    processedKeys: Set<string>;
-    result: [string, string | string[]][];
-    constructor(metadata: Record<string, string | string[]>, config: MetadataConfiguration);
-    process(): [string, string | string[]][];
-    private addMatchingKeys;
-    private findMatchingKeys;
-    private addItemByStringKey;
-    private sortKeys;
-}
-export default MetadataProcessor;

package/lib/pdf/template_helpers/when.d.ts

@@ -1,13 +0,0 @@
-import WhenCallback from './when_callback';
-import WhenClause from './when_clause';
-declare class When {
-    condition: boolean;
-    clauses: WhenClause[];
-    constructor(condition: any, thenCallback?: WhenCallback);
-    then(thenCallback: WhenCallback): When;
-    elseWhen(condition: any, callback?: WhenCallback): When;
-    else(callback: WhenCallback): When;
-    private add;
-    toString(): string;
-}
-export default When;

package/lib/pdf/template_helpers/when_callback.d.ts

@@ -1,2 +0,0 @@
-type WhenCallback = () => string;
-export default WhenCallback;

package/lib/pdf/template_helpers/when_clause.d.ts

@@ -1,8 +0,0 @@
-import WhenCallback from './when_callback';
-declare class WhenClause {
-    condition: boolean;
-    callback: WhenCallback;
-    constructor(condition: any, callback: WhenCallback);
-    evaluate(otherClauses: WhenClause[]): string;
-}
-export default WhenClause;

package/lib/pdf/template_helpers.d.ts

@@ -1,64 +0,0 @@
-import Evaluatable from './chord_sheet/chord_pro/evaluatable';
-import Font from './chord_sheet/font';
-import Item from './chord_sheet/item';
-import Line from './chord_sheet/line';
-import Metadata from './chord_sheet/metadata';
-import { MetadataConfiguration } from './formatter/configuration/base_configuration';
-import Paragraph from './chord_sheet/paragraph';
-import Tag from './chord_sheet/tag';
-import When from './template_helpers/when';
-import WhenCallback from './template_helpers/when_callback';
-import { renderChord } from './helpers';
-import { hasChordContents, isEvaluatable } from './utilities';
-import { Configuration, HtmlTemplateCssClasses } from './formatter/configuration';
-type EachCallback = (_item: any) => string;
-export { hasChordContents, isEvaluatable } from './utilities';
-export { renderChord } from './helpers';
-import { pangoToHtml, stripPangoMarkup } from './pango/pango_helpers';
-export { pangoToHtml, stripPangoMarkup };
-export declare function isChordLyricsPair(item: Item): boolean;
-export declare function isRhythmSymbol(item: Item): boolean;
-export declare function lineHasContents(line: Line): boolean;
-export declare function isTag(item: Item): boolean;
-export declare function isLiteral(item: Item): boolean;
-export declare function isComment(item: Tag): boolean;
-export declare function isImage(item: Tag): boolean;
-export declare function imageTag(item: Tag): string;
-export declare function isColumnBreak(item: Item): boolean;
-export declare function isSoftLineBreak(item: Item): boolean;
-export declare function stripHTML(string: string): string;
-export declare function newlinesToBreaks(string: string): string;
-export declare function renderSection(paragraph: Paragraph, configuration: Configuration): string;
-export declare function each(collection: any[], callback: EachCallback): string;
-export declare function when(condition: any, callback?: WhenCallback): When;
-export declare function hasTextContents(line: Line): boolean;
-export declare function lineClasses(line: Line, cssClasses: HtmlTemplateCssClasses): string;
-export declare function paragraphClasses(paragraph: Paragraph, cssClasses: HtmlTemplateCssClasses): string;
-export declare function evaluate(item: Evaluatable, metadata: Metadata, configuration: Configuration): string;
-export declare function fontStyleTag(font: Font): string;
-export declare function processMetadata(metadata: Record<string, string | string[]>, config: MetadataConfiguration): [string, string | string[]][];
-declare const _default: {
-    isLiteral: typeof isLiteral;
-    isSoftLineBreak: typeof isSoftLineBreak;
-    isEvaluatable: typeof isEvaluatable;
-    isChordLyricsPair: typeof isChordLyricsPair;
-    lineHasContents: typeof lineHasContents;
-    isTag: typeof isTag;
-    isComment: typeof isComment;
-    isImage: typeof isImage;
-    isColumnBreak: typeof isColumnBreak;
-    stripHTML: typeof stripHTML;
-    each: typeof each;
-    when: typeof when;
-    hasTextContents: typeof hasTextContents;
-    lineClasses: typeof lineClasses;
-    paragraphClasses: typeof paragraphClasses;
-    evaluate: typeof evaluate;
-    fontStyleTag: typeof fontStyleTag;
-    renderChord: typeof renderChord;
-    hasChordContents: typeof hasChordContents;
-    pangoToHtml: typeof pangoToHtml;
-    stripPangoMarkup: typeof stripPangoMarkup;
-    processMetadata: typeof processMetadata;
-};
-export default _default;

package/lib/pdf/utilities.d.ts

@@ -1,35 +0,0 @@
-import Item from './chord_sheet/item';
-import Line from './chord_sheet/line';
-import { Accidental, AccidentalMaybe, ChordType } from './constants';
-export declare function callChain<T>(value: T, functions: ((_value: T) => T)[]): T;
-export declare function hasChordContents(line: Line): boolean;
-export declare function hasRemarkContents(line: Line): boolean;
-export declare function isEvaluatable(item: Item): boolean;
-export declare function padLeft(string: string, length: number): string;
-type ObjectWithLength = any[] | string | null;
-export declare function isPresent(object: ObjectWithLength): boolean;
-type CssObject = Record<string, Record<string, string>>;
-export declare function scopeCss(css: CssObject, scope?: string): string;
-export declare function warn(message: string): void;
-export declare function deprecate(message: string): void;
-export declare function isEmptyString(string: string | null | undefined): boolean;
-export declare function isMinor(key: string | number, keyType: ChordType, suffix: any): boolean;
-export declare function normalizeLineEndings(string: string): string;
-export declare function gradeToKey(options: {
-    type: ChordType;
-    accidental: AccidentalMaybe | null;
-    preferredAccidental: Accidental | null;
-    grade: number;
-    minor: boolean;
-}): string;
-export declare function normalizeChordSuffix(suffix: string | null): string | null;
-declare let mergeConfigs: <T>(target: T, source: any) => T;
-export { mergeConfigs };
-/**
- * Utility type that creates a deep partial type
- * This makes all properties optional recursively through the entire object
- */
-export type DeepPartial<T> = T extends object ? {
-    [P in keyof T]?: DeepPartial<T[P]>;
-} : T;
-export declare function filterObject<T>(object: Record<string, T>, predicate: (key: string, value: T) => boolean): Record<string, T>;

package/lib/pdf/version.d.ts

@@ -1,2 +0,0 @@
-declare const _default: "15.0.0";
-export default _default;