@docx4j/core-ts 0.4.0 → 0.6.0

package/dist/model/text/commonmark.d.mts

@@ -0,0 +1,121 @@
+/** A node of the Markdown tree: its parent and children (commonmark-java `Node`). */
+export declare abstract class MdNode {
+    parent: MdNode | undefined;
+    readonly children: MdNode[];
+    /** What the node was made for, where a caller wants to know where its Markdown begins (`MarkdownExporter.blocks`). */
+    tag: unknown;
+    get firstChild(): MdNode | undefined;
+    get lastChild(): MdNode | undefined;
+    get previous(): MdNode | undefined;
+    get next(): MdNode | undefined;
+    appendChild(child: MdNode): void;
+    prependChild(child: MdNode): void;
+    private unlink;
+}
+export declare class MdDocument extends MdNode {
+}
+export declare class MdParagraph extends MdNode {
+}
+export declare class MdBlockQuote extends MdNode {
+}
+export declare class MdHardLineBreak extends MdNode {
+}
+export declare class MdStrongEmphasis extends MdNode {
+}
+export declare class MdTableBlock extends MdNode {
+}
+export declare class MdTableHead extends MdNode {
+}
+export declare class MdTableBody extends MdNode {
+}
+export declare class MdTableRow extends MdNode {
+}
+export declare class MdHeading extends MdNode {
+    readonly level: number;
+    constructor(level: number);
+}
+/** A bullet or ordered list: tight when its items are not separated by blank lines. */
+export declare abstract class MdListBlock extends MdNode {
+    tight: boolean;
+}
+export declare class MdBulletList extends MdListBlock {
+    /** `-` where unset. */
+    marker: string | undefined;
+}
+export declare class MdOrderedList extends MdListBlock {
+    /** 1 where unset. */
+    markerStartNumber: number | undefined;
+    /** `.` where unset. */
+    markerDelimiter: string | undefined;
+}
+export declare class MdListItem extends MdNode {
+}
+export declare class MdFencedCodeBlock extends MdNode {
+    readonly literal: string;
+    constructor(literal: string);
+}
+export declare class MdThematicBreak extends MdNode {
+    readonly literal: string | undefined;
+    constructor(literal: string | undefined);
+}
+export declare class MdHtmlInline extends MdNode {
+    readonly literal: string;
+    constructor(literal: string);
+}
+export declare class MdText extends MdNode {
+    literal: string;
+    constructor(literal: string);
+}
+export declare class MdCode extends MdNode {
+    readonly literal: string;
+    constructor(literal: string);
+}
+export declare class MdEmphasis extends MdNode {
+}
+export declare class MdLink extends MdNode {
+    readonly destination: string;
+    readonly title: string | undefined;
+    constructor(destination: string, title: string | undefined);
+}
+export declare class MdImage extends MdNode {
+    destination: string;
+    readonly title: string | undefined;
+    constructor(destination: string, title: string | undefined);
+}
+export type MdAlignment = 'LEFT' | 'CENTER' | 'RIGHT';
+export declare class MdTableCell extends MdNode {
+    readonly header: boolean;
+    alignment: MdAlignment | undefined;
+    constructor(header: boolean);
+}
+export declare class MdStrikethrough extends MdNode {
+    readonly delimiter: string;
+    constructor(delimiter: string);
+}
+export declare class MdFootnoteDefinition extends MdNode {
+    readonly label: string;
+    constructor(label: string);
+}
+export declare class MdFootnoteReference extends MdNode {
+    readonly label: string;
+    constructor(label: string);
+}
+/** Inline math, `$...$` (docx4j `InlineMath`). */
+export declare class MdInlineMath extends MdNode {
+    readonly literal: string;
+    readonly displayHint: boolean;
+    constructor(literal: string, displayHint: boolean);
+}
+/** Display math, a `$$` block (docx4j `DisplayMath`). */
+export declare class MdDisplayMath extends MdNode {
+    readonly literal: string;
+    constructor(literal: string);
+}
+/** Where each tagged node's Markdown begins: the start of the line its first character is written on. */
+export type TagStarts = Map<unknown, number>;
+/**
+ * Renders a Markdown tree as commonmark-java's `MarkdownRenderer` does, with the tables, strikethrough,
+ * footnotes and docx4j math extensions. `starts` receives, for each node with a `tag`, the offset of the
+ * line its first character is written on.
+ */
+export declare function renderMarkdown(document: MdDocument, starts?: TagStarts): string;