chordsheetjs 14.6.1 → 15.0.0

package/lib/pdf/formatter/pdf_formatter/types.d.ts

@@ -0,0 +1,34 @@
+import { ImageCompression, ImageOptions, RGBAData, TextOptionsLight, jsPDFOptions } from 'jspdf';
+export interface PdfDoc {
+    get internal(): {
+        pageSize: {
+            getWidth(): number;
+        };
+    };
+    addImage(imageData: string | HTMLImageElement | HTMLCanvasElement | Uint8Array | RGBAData, format: string, x: number, y: number, width: number, height: number, alias?: string, compression?: ImageCompression, rotation?: number): PdfDoc;
+    addImage(imageData: string | HTMLImageElement | HTMLCanvasElement | Uint8Array | RGBAData, x: number, y: number, width: number, height: number, alias?: string, compression?: ImageCompression, rotation?: number): PdfDoc;
+    addImage(options: ImageOptions): PdfDoc;
+    circle(x: number, y: number, r: number, style?: string | null): PdfDoc;
+    getTextDimensions(text: string, options?: TextOptionsLight): {
+        w: number;
+        h: number;
+    };
+    line(x1: number, y1: number, x2: number, y2: number, style?: string | null): PdfDoc;
+    roundedRect(x: number, y: number, w: number, h: number, rx: number, ry: number, style?: string | null): PdfDoc;
+    save(filename: string, options: {
+        returnPromise: true;
+    }): Promise<void>;
+    save(filename?: string): PdfDoc;
+    setDrawColor(ch1: string | number, ch2?: number, ch3?: number, ch4?: number): PdfDoc;
+    setFont(fontName: string, fontStyle?: string, fontWeight?: string | number): PdfDoc;
+    setFontSize(size: number): PdfDoc;
+    setPage(page: number): PdfDoc;
+    setLineWidth(width: number): PdfDoc;
+    setTextColor(ch1: string): PdfDoc;
+    setTextColor(ch1: number): PdfDoc;
+    setTextColor(ch1: number, ch2: number, ch3: number, ch4?: number): PdfDoc;
+    text(text: string | string[], x: number, y: number, options?: TextOptionsLight, transform?: any): PdfDoc;
+    addFileToVFS(fileName: string, data: string): PdfDoc;
+    addFont(postScriptName: string, id: string, fontStyle: string, fontWeight?: string | number, encoding?: 'StandardEncoding' | 'MacRomanEncoding' | 'Identity-H' | 'WinAnsiEncoding', isStandardFont?: boolean): string;
+}
+export type PdfConstructor = new (options?: jsPDFOptions) => PdfDoc;

package/lib/pdf/formatter/pdf_formatter.d.ts

@@ -0,0 +1,40 @@
+import { Blob } from 'buffer';
+import DocWrapper from './pdf_formatter/doc_wrapper';
+import MeasurementBasedFormatter from './measurement_based_formatter';
+import { PDFFormatterConfiguration } from './configuration';
+import { PdfConstructor } from './pdf_formatter/types';
+import Song from '../chord_sheet/song';
+/**
+ * PdfFormatter formats a song into a PDF document.
+ */
+declare class PdfFormatter extends MeasurementBasedFormatter<PDFFormatterConfiguration> {
+    private song;
+    private renderer;
+    /**
+     * Get the default configuration for PDF formatter
+     */
+    protected getDefaultConfiguration(): PDFFormatterConfiguration;
+    /**
+     * Formats a song into a PDF.
+     * @param song - The song to format.
+     * @param docConstructor - The PDF document constructor.
+     */
+    format(song: Song, docConstructor?: PdfConstructor): void;
+    /**
+     * Create the layout engine with the appropriate configuration
+     */
+    private createLayoutEngine;
+    /**
+     * Save the formatted document as a PDF file
+     */
+    save(): void;
+    /**
+     * Generate the PDF as a Blob object
+     */
+    generatePDF(): Promise<Blob>;
+    /**
+     * Get the document wrapper - primarily for testing purposes.
+     */
+    getDocumentWrapper(): DocWrapper;
+}
+export default PdfFormatter;

package/lib/pdf/formatter/templates/html_div_formatter.d.ts

@@ -0,0 +1,3 @@
+import { HtmlTemplateArgs } from '../html_formatter';
+declare const _default: ({ configuration, configuration: { key, cssClasses: c, }, song, metadata, renderBlankLines, song: { title, subtitle, }, bodyParagraphs, }: HtmlTemplateArgs) => string;
+export default _default;

package/lib/pdf/formatter/templates/html_table_formatter.d.ts

@@ -0,0 +1,3 @@
+import { HtmlTemplateArgs } from '../html_formatter';
+declare const _default: ({ configuration, configuration: { key, cssClasses: c, }, song, metadata, renderBlankLines, song: { title, subtitle, bodyLines, }, bodyParagraphs, }: HtmlTemplateArgs) => string;
+export default _default;

package/lib/pdf/formatter/text_formatter.d.ts

@@ -0,0 +1,35 @@
+import ChordLyricsPair from '../chord_sheet/chord_lyrics_pair';
+import Formatter from './formatter';
+import Item from '../chord_sheet/item';
+import Line from '../chord_sheet/line';
+import Metadata from '../chord_sheet/metadata';
+import Paragraph from '../chord_sheet/paragraph';
+import Song from '../chord_sheet/song';
+/**
+ * Formats a song into a plain text chord sheet
+ */
+declare class TextFormatter extends Formatter {
+    song: Song;
+    metadata: Metadata;
+    /**
+     * Formats a song into a plain text chord sheet
+     * @param {Song} song The song to be formatted
+     * @param {Metadata} metadata Optional override of metadata used for formatting
+     * @returns {string} the chord sheet
+     */
+    format(song: Song, metadata?: Metadata): string;
+    formatHeader(): string;
+    formatParagraphs(): string;
+    formatParagraph(paragraph: Paragraph, metadata: Metadata): string;
+    formatLine(line: Line, metadata: Metadata): string;
+    formatTitle(title: string | null): string;
+    formatSubTitle(subtitle: string | null): string;
+    formatLineTop(line: Line, metadata: Metadata): string | null;
+    chordLyricsPairLength(chordLyricsPair: ChordLyricsPair, line: Line): number;
+    private renderChords;
+    formatItemTop(item: Item, _metadata: Metadata, line: Line): string;
+    formatLineBottom(line: Line, metadata: Metadata): string;
+    formatLineWithFormatter(line: Line, formatter: (_item: Item, _metadata: Metadata, _line: Line) => string, metadata: Metadata): string;
+    formatItemBottom(item: Item, metadata: Metadata, line: Line): string;
+}
+export default TextFormatter;

package/lib/pdf/helpers.d.ts

@@ -0,0 +1,42 @@
+import FormattingContext from './formatter/formatting_context';
+import Key from './key';
+import Line from './chord_sheet/line';
+import Song from './chord_sheet/song';
+export declare function transposeDistance(transposeKey: string, songKey: string | Key): number;
+interface RenderChordOptions {
+    renderKey?: Key | null;
+    useUnicodeModifier?: boolean;
+    normalizeChords?: boolean;
+    decapo?: boolean;
+}
+/**
+ * Renders a chord in the context of a line and song and taking into account some options
+ * @param chordString The chord to render
+ * @param line The line the chord is in
+ * @param song The song the line is in
+ * @param renderKey The key to render the chord in. If not provided, the line key will be used,
+ * or the song key if the line key is not provided.
+ * @param useUnicodeModifier Whether to use unicode modifiers ('\u266f'/'\u266d') or plain text ('#'/'b').
+ * Default `false`.
+ * @param normalizeChords Whether to normalize the chord to the key (default `true`)
+ * @param decapo Whether to transpose all chords to eliminate the capo (default `false`)
+ */
+export declare function renderChord(chordString: string, line: Line, song: Song, { renderKey, useUnicodeModifier, normalizeChords, decapo, }?: RenderChordOptions): string;
+/**
+ * Returns applicable capos for the provided key
+ * @param {Key|string} key The key to get capos for
+ * @returns {Object.<string, string>} The available capos, where the keys are capo numbers and the
+ * values are the effective key for that capo.
+ */
+export declare function getCapos(key: Key | string): Record<string, string>;
+/**
+ * Returns applicable keys to transpose to from the provided key
+ * @param {Key|string} key The key to get keys for
+ * @returns {Array<string>} The available keys
+ */
+export declare function getKeys(key: Key | string): string[];
+export declare function testSelector({ selector, isNegated }: {
+    selector: string;
+    isNegated: boolean;
+}, { configuration, metadata }: FormattingContext): boolean;
+export {};

package/lib/pdf/index.d.ts

@@ -0,0 +1,126 @@
+import Chord from './chord';
+import ChordDefinition from './chord_definition/chord_definition';
+import ChordLyricsPair from './chord_sheet/chord_lyrics_pair';
+import ChordProFormatter from './formatter/chord_pro_formatter';
+import ChordProParser from './parser/chord_pro_parser';
+import ChordSheetParser from './parser/chord_sheet_parser';
+import ChordSheetSerializer from './chord_sheet_serializer';
+import ChordsOverWordsFormatter from './formatter/chords_over_words_formatter';
+import ChordsOverWordsParser from './parser/chords_over_words_parser';
+import Comment from './chord_sheet/comment';
+import Composite from './chord_sheet/chord_pro/composite';
+import HtmlDivFormatter from './formatter/html_div_formatter';
+import HtmlTableFormatter from './formatter/html_table_formatter';
+import Line from './chord_sheet/line';
+import Literal from './chord_sheet/chord_pro/literal';
+import MeasuredHtmlFormatter from './formatter/measured_html_formatter';
+import Metadata from './chord_sheet/metadata';
+import Paragraph from './chord_sheet/paragraph';
+import SoftLineBreak from './chord_sheet/soft_line_break';
+import Song from './chord_sheet/song';
+import Tag from './chord_sheet/tag';
+import Ternary from './chord_sheet/chord_pro/ternary';
+import TextFormatter from './formatter/text_formatter';
+import UltimateGuitarParser from './parser/ultimate_guitar_parser';
+import { each, evaluate, fontStyleTag, hasChordContents, hasTextContents, isChordLyricsPair, isComment, isEvaluatable, isImage, isTag, lineClasses, lineHasContents, pangoToHtml, paragraphClasses, renderChord, stripHTML, stripPangoMarkup, when } from './template_helpers';
+import { BaseMeasurer } from './layout/measurement';
+import { CanvasMeasurer } from './layout/measurement';
+import { DomMeasurer } from './layout/measurement';
+import { LayoutEngine } from './layout/engine';
+export { default as Chord } from './chord';
+export { default as ChordDefinition } from './chord_definition/chord_definition';
+export { default as ChordLyricsPair } from './chord_sheet/chord_lyrics_pair';
+export { default as ChordProFormatter } from './formatter/chord_pro_formatter';
+export { default as MeasuredHtmlFormatter } from './formatter/measured_html_formatter';
+export { default as ChordProParser } from './parser/chord_pro_parser';
+export { default as ChordSheetParser } from './parser/chord_sheet_parser';
+export { default as ChordSheetSerializer } from './chord_sheet_serializer';
+export { default as ChordsOverWordsFormatter } from './formatter/chords_over_words_formatter';
+export { default as ChordsOverWordsParser } from './parser/chords_over_words_parser';
+export { default as Comment } from './chord_sheet/comment';
+export { default as Composite } from './chord_sheet/chord_pro/composite';
+export { default as Formatter } from './formatter/formatter';
+export { default as HtmlDivFormatter } from './formatter/html_div_formatter';
+export { default as HtmlFormatter } from './formatter/html_formatter';
+export { default as HtmlTableFormatter } from './formatter/html_table_formatter';
+export { default as Key } from './key';
+export { default as Line } from './chord_sheet/line';
+export { default as Literal } from './chord_sheet/chord_pro/literal';
+export { default as Metadata } from './chord_sheet/metadata';
+export { default as Paragraph } from './chord_sheet/paragraph';
+export { default as SoftLineBreak } from './chord_sheet/soft_line_break';
+export { default as Song } from './chord_sheet/song';
+export { default as Tag } from './chord_sheet/tag';
+export { default as Ternary } from './chord_sheet/chord_pro/ternary';
+export { default as TextFormatter } from './formatter/text_formatter';
+export { default as UltimateGuitarParser } from './parser/ultimate_guitar_parser';
+export { default as templateHelpers } from './template_helpers';
+export { default as version } from './version';
+export { IMAGE } from './chord_sheet/tags';
+export { defaultPangoRenderer, pangoToHtml, stripPangoMarkup } from './pango/pango_helpers';
+export type { PangoRenderer } from './pango/pango_helpers';
+export * from './serialized_types';
+export { BaseMeasurer } from './layout/measurement/measurer';
+export { DomMeasurer } from './layout/measurement';
+export { CanvasMeasurer } from './layout/measurement';
+export { LayoutEngine } from './layout/engine/layout_engine';
+export { ABC, CHORUS, INDETERMINATE, LILYPOND, NONE, SVG, NUMERIC, SOLFEGE, SYMBOL, TAB, TEXTBLOCK, VERSE, PART, NUMERAL, } from './constants';
+declare const _default: {
+    CHORUS: string;
+    Chord: typeof Chord;
+    ChordDefinition: typeof ChordDefinition;
+    ChordLyricsPair: typeof ChordLyricsPair;
+    ChordProFormatter: typeof ChordProFormatter;
+    MeasuredHtmlFormatter: typeof MeasuredHtmlFormatter;
+    ChordProParser: typeof ChordProParser;
+    ChordSheetParser: typeof ChordSheetParser;
+    ChordSheetSerializer: typeof ChordSheetSerializer;
+    ChordsOverWordsFormatter: typeof ChordsOverWordsFormatter;
+    ChordsOverWordsParser: typeof ChordsOverWordsParser;
+    Comment: typeof Comment;
+    Composite: typeof Composite;
+    HtmlDivFormatter: typeof HtmlDivFormatter;
+    HtmlTableFormatter: typeof HtmlTableFormatter;
+    INDETERMINATE: string;
+    Line: typeof Line;
+    Literal: typeof Literal;
+    Metadata: typeof Metadata;
+    NONE: string;
+    Paragraph: typeof Paragraph;
+    PART: string;
+    SoftLineBreak: typeof SoftLineBreak;
+    Song: typeof Song;
+    TAB: string;
+    TEXTBLOCK: string;
+    Tag: typeof Tag;
+    Ternary: typeof Ternary;
+    TextFormatter: typeof TextFormatter;
+    UltimateGuitarParser: typeof UltimateGuitarParser;
+    VERSE: string;
+    BaseMeasurer: typeof BaseMeasurer;
+    DomMeasurer: typeof DomMeasurer;
+    CanvasMeasurer: typeof CanvasMeasurer;
+    LayoutEngine: typeof LayoutEngine;
+    version: string;
+    templateHelpers: {
+        isEvaluatable: typeof isEvaluatable;
+        isChordLyricsPair: typeof isChordLyricsPair;
+        lineHasContents: typeof lineHasContents;
+        isTag: typeof isTag;
+        isComment: typeof isComment;
+        isImage: typeof isImage;
+        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;
+    };
+};
+export default _default;