chordsheetjs 14.6.1 → 15.0.0

package/lib/pdf/song_builder.d.ts

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

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

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

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

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

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

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

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

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

package/package.json

@@ -1,12 +1,24 @@
 {
   "name": "chordsheetjs",
   "author": "Martijn Versluis",
-  "version": "14.6.1",
+  "version": "15.0.0",
   "description": "A JavaScript library for parsing and formatting chord sheets",
   "source": "src/index.ts",
   "main": "lib/index.js",
   "module": "lib/module.js",
   "types": "lib/main.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/main.d.ts",
+      "import": "./lib/module.js",
+      "require": "./lib/index.js"
+    },
+    "./pdf": {
+      "types": "./lib/pdf/pdf.d.ts",
+      "import": "./lib/pdf/module.js",
+      "require": "./lib/pdf/index.js"
+    }
+  },
   "files": [
     "/lib"
   ],
@@ -51,6 +63,7 @@
     "globals": "^17.0.0",
     "jest": "^30.0.0",
     "js-levenshtein": "^1.1.6",
+    "jspdf": "^4.0.0",
     "parcel": "2.16.4",
     "peggy": "^5.0.2",
     "pegjs-backtrace": "^0.2.1",
@@ -86,8 +99,13 @@
     "test": "yarn unibuild lint && yarn unibuild test",
     "playground": "cd playground && parcel index.html --port=3300 --no-cache"
   },
-  "dependencies": {
+  "peerDependencies": {
     "jspdf": "^4.0.0"
   },
+  "peerDependenciesMeta": {
+    "jspdf": {
+      "optional": true
+    }
+  },
   "packageManager": "yarn@4.2.2"
 }