markdown builder improvements

Author: mProjectsCode

jsEngine/api/MarkdownAPI.ts

@@ -53,7 +53,7 @@ export class MarkdownAPI {
 	public createText(text: string): TextElement {
 		validateAPIArgs(z.object({ text: z.string() }), { text });
 
-		return new TextElement(this.apiInstance, text, false, false, false);
+		return new TextElement(this.apiInstance, text, false, false, false, false);
 	}
 
 	/**
@@ -64,7 +64,7 @@ export class MarkdownAPI {
 	public createBoldText(text: string): TextElement {
 		validateAPIArgs(z.object({ text: z.string() }), { text });
 
-		return new TextElement(this.apiInstance, text, true, false, false);
+		return new TextElement(this.apiInstance, text, true, false, false, false);
 	}
 
 	/**
@@ -75,7 +75,7 @@ export class MarkdownAPI {
 	public createCursiveText(text: string): TextElement {
 		validateAPIArgs(z.object({ text: z.string() }), { text });
 
-		return new TextElement(this.apiInstance, text, false, true, false);
+		return new TextElement(this.apiInstance, text, false, true, false, false);
 	}
 
 	/**
@@ -86,7 +86,18 @@ export class MarkdownAPI {
 	public createUnderlinedText(text: string): TextElement {
 		validateAPIArgs(z.object({ text: z.string() }), { text });
 
-		return new TextElement(this.apiInstance, text, false, false, true);
+		return new TextElement(this.apiInstance, text, false, false, true, false);
+	}
+
+	/**
+	 * Creates a new markdown text element with highlighted formatting.
+	 *
+	 * @param text
+	 */
+	public createHighlightedText(text: string): TextElement {
+		validateAPIArgs(z.object({ text: z.string() }), { text });
+
+		return new TextElement(this.apiInstance, text, false, false, false, true);
 	}
 
 	/**
@@ -151,7 +162,7 @@ export class MarkdownAPI {
 	 * @param args the callout args, optional
 	 * @param collapsed whether the callout should be collapsed by default, optional
 	 */
-	createCollapsibleCallout(title: string, type: string, args: string = '', collapsed: boolean = false): CalloutElement {
+	public createCollapsibleCallout(title: string, type: string, args: string = '', collapsed: boolean = false): CalloutElement {
 		validateAPIArgs(z.object({ title: z.string(), type: z.string(), args: z.string(), collapsed: z.boolean() }), { title, type, args, collapsed });
 
 		return new CalloutElement(this.apiInstance, title, type, args, true, collapsed);
@@ -184,11 +195,18 @@ export class MarkdownAPI {
 	/**
 	 * Creates a new markdown list element.
 	 *
-	 * @param ordered whether the list should be ordered or not (use 1. or -)
+	 * @param ordered whether the list should be ordered or not (use 1. or -), defaults to unordered
 	 */
-	createList(ordered: boolean): ListElement {
+	public createList(ordered: boolean = false): ListElement {
 		validateAPIArgs(z.object({ ordered: z.boolean() }), { ordered });
 
 		return new ListElement(this.apiInstance, ordered);
 	}
+
+	/**
+	 * Creates a new ordered markdown list element.
+	 */
+	public createOrderedList(): ListElement {
+		return new ListElement(this.apiInstance, true);
+	}
 }

jsEngine/api/markdown/AbstractMarkdownElementContainer.ts

@@ -45,31 +45,39 @@ export abstract class AbstractMarkdownElementContainer extends AbstractMarkdownE
 	addText(text: string): AbstractMarkdownElementContainer {
 		validateAPIArgs(z.object({ text: z.string() }), { text });
 
-		const element = new TextElement(this.apiInstance, text, false, false, false);
+		const element = new TextElement(this.apiInstance, text, false, false, false, false);
 		this.addElement(element);
 		return this;
 	}
 
 	addBoldText(text: string): AbstractMarkdownElementContainer {
 		validateAPIArgs(z.object({ text: z.string() }), { text });
 
-		const element = new TextElement(this.apiInstance, text, true, false, false);
+		const element = new TextElement(this.apiInstance, text, true, false, false, false);
 		this.addElement(element);
 		return this;
 	}
 
 	addCursiveText(text: string): AbstractMarkdownElementContainer {
 		validateAPIArgs(z.object({ text: z.string() }), { text });
 
-		const element = new TextElement(this.apiInstance, text, false, true, false);
+		const element = new TextElement(this.apiInstance, text, false, true, false, false);
 		this.addElement(element);
 		return this;
 	}
 
 	addUnderlinedText(text: string): AbstractMarkdownElementContainer {
 		validateAPIArgs(z.object({ text: z.string() }), { text });
 
-		const element = new TextElement(this.apiInstance, text, false, false, true);
+		const element = new TextElement(this.apiInstance, text, false, false, true, false);
+		this.addElement(element);
+		return this;
+	}
+
+	addHighlightedText(text: string): AbstractMarkdownElementContainer {
+		validateAPIArgs(z.object({ text: z.string() }), { text });
+
+		const element = new TextElement(this.apiInstance, text, false, false, false, true);
 		this.addElement(element);
 		return this;
 	}
@@ -136,13 +144,19 @@ export abstract class AbstractMarkdownElementContainer extends AbstractMarkdownE
 		return element;
 	}
 
-	createList(ordered: boolean): ListElement {
+	createList(ordered: boolean = false): ListElement {
 		validateAPIArgs(z.object({ ordered: z.boolean() }), { ordered });
 
 		const element = new ListElement(this.apiInstance, ordered);
 		this.addElement(element);
 		return element;
 	}
+
+	createOrderedList(): ListElement {
+		const element = new ListElement(this.apiInstance, true);
+		this.addElement(element);
+		return element;
+	}
 }
 
 // --------------------------------------------
@@ -157,23 +171,25 @@ export class TextElement extends AbstractMarkdownLiteral {
 	bold: boolean;
 	cursive: boolean;
 	underline: boolean;
+	highlight: boolean;
 
-	constructor(apiInstance: API, content: string, bold: boolean, cursive: boolean, underline: boolean) {
+	constructor(apiInstance: API, content: string, bold: boolean, cursive: boolean, underline: boolean, highlight: boolean) {
 		super(apiInstance);
 
 		this.content = content;
 		this.bold = bold;
 		this.cursive = cursive;
 		this.underline = underline;
+		this.highlight = highlight;
 	}
 
 	public toString(): string {
 		let prefix: string = '';
 		let postfix: string = '';
 
 		if (this.underline) {
-			prefix += '<b>';
-			postfix = '</b>' + postfix;
+			prefix += '<u>';
+			postfix = '</u>' + postfix;
 		}
 
 		if (this.bold) {
@@ -186,6 +202,11 @@ export class TextElement extends AbstractMarkdownLiteral {
 			postfix = '*' + postfix;
 		}
 
+		if (this.highlight) {
+			prefix += '==';
+			postfix = '==' + postfix;
+		}
+
 		return prefix + this.content + postfix;
 	}
 }