@cparra/apexdocs 2.25.0-alpha.9 → 2.25.0

package/lib/model/manifest.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
+ */
+class Manifest {
+    /**
+     * Constructs a new Manifest object.
+     * @param types List of types to be wrapped by this object.
+     * @param isForInnerTypes Whether this manifest represent an inner type or not.
+     */
+    constructor(types, isForInnerTypes = false) {
+        this.types = types;
+        this.isForInnerTypes = isForInnerTypes;
+    }
+    filteredByAccessModifierAndAnnotations(modifiers) {
+        const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
+        const typesToReturn = [];
+        for (const filteredType of filteredTypes) {
+            const currentType = filteredType;
+            if (currentType.type_name !== 'class') {
+                typesToReturn.push(currentType);
+                continue;
+            }
+            const currentClass = currentType;
+            let filteredClass = Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentClass.methods, modifiers), properties: this.filterAccessibleModifier(currentClass.properties, modifiers), fields: this.filterAccessibleModifier(currentClass.fields, modifiers), constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers) });
+            if (!this.isForInnerTypes) {
+                filteredClass = Object.assign(Object.assign({}, filteredClass), { enums: this.filterAccessibleModifier(currentClass.enums, modifiers), interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers), classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(modifiers) });
+            }
+            typesToReturn.push(filteredClass);
+        }
+        return typesToReturn;
+    }
+    filterAccessibleModifier(accessAndDocAwares, modifiers) {
+        return accessAndDocAwares.filter((currentType) => {
+            var _a;
+            const hasIgnoreDocAnnotation = (_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name === 'ignore');
+            if (hasIgnoreDocAnnotation) {
+                return false;
+            }
+            return (modifiers.includes(currentType.access_modifier) ||
+                currentType.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase())));
+        });
+    }
+}
+exports.default = Manifest;
+//# sourceMappingURL=manifest.js.map

package/lib/model/manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../src/model/manifest.ts"],"names":[],"mappings":";;AAYA;;GAEG;AACH,MAAqB,QAAQ;IAC3B;;;;OAIG;IACH,YAAmB,KAAa,EAAS,kBAA2B,KAAK;QAAtD,UAAK,GAAL,KAAK,CAAQ;QAAS,oBAAe,GAAf,eAAe,CAAiB;IAAG,CAAC;IAE7E,sCAAsC,CAAC,SAAmB;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAW,EAAE,CAAC;QACjC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;YACxC,MAAM,WAAW,GAAG,YAAoB,CAAC;YACzC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;gBACrC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAChC,SAAS;aACV;YAED,MAAM,YAAY,GAAG,WAA0B,CAAC;YAChD,IAAI,aAAa,mCACZ,WAAW,KACd,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EACvE,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,EAC7E,MAAM,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,EACrE,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,GAClF,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;gBACzB,aAAa,mCACR,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAiB,EACnF,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAsB,EAClG,OAAO,EAAE,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,sCAAsC,CACtF,SAAS,CACO,GACnB,CAAC;aACH;YAED,aAAa,CAAC,IAAI,CAAC,aAA4B,CAAC,CAAC;SAClD;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wBAAwB,CAAC,kBAAuC,EAAE,SAAmB;QACnF,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE;;YAC/C,MAAM,sBAAsB,GAAG,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACrE,CAAC,UAAgC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,QAAQ,CACnE,CAAC;YACF,IAAI,sBAAsB,EAAE;gBAC1B,OAAO,KAAK,CAAC;aACd;YACD,OAAO,CACL,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC;gBAC/C,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAsB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAC5G,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA1DD,2BA0DC"}

package/lib/model/markdown-file.d.ts

@@ -0,0 +1,16 @@
+import { OutputFile } from './outputFile';
+export declare class MarkdownFile extends OutputFile {
+    fileExtension(): string;
+    addTitle(text: string, level?: number): void;
+    addText(text: string, encodeHtml?: boolean): void;
+    addLink(text: string, encodeHtml?: boolean): void;
+    startCodeBlock(language?: string): void;
+    endCodeBlock(): void;
+    addHorizontalRule(): void;
+    initializeTable(...headers: string[]): void;
+    addTableRow(...columns: string[]): void;
+    addListItem(text: string): void;
+    protected static replaceInlineLinks(text: string): string;
+    protected static replaceInlineEmails(text: string): string;
+    private _replaceInlineReferences;
+}

package/lib/model/markdown-file.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownFile = void 0;
+const outputFile_1 = require("./outputFile");
+const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
+class MarkdownFile extends outputFile_1.OutputFile {
+    fileExtension() {
+        return '.md';
+    }
+    addTitle(text, level = 1) {
+        let title = '';
+        for (let i = 0; i < level; i++) {
+            title += '#';
+        }
+        title += ' ';
+        title += text;
+        this._contents += title;
+        this.addBlankLine();
+    }
+    addText(text, encodeHtml = true) {
+        super.addText(this._replaceInlineReferences(text), encodeHtml);
+    }
+    addLink(text, encodeHtml = true) {
+        this.addText(`\{@link ${text}\}`, encodeHtml);
+    }
+    startCodeBlock(language = 'apex') {
+        this.addText(`\`\`\`${language}`);
+    }
+    endCodeBlock() {
+        this.addText('```');
+        this.addBlankLine();
+    }
+    addHorizontalRule() {
+        this._contents += '---';
+        this.addBlankLine();
+    }
+    initializeTable(...headers) {
+        this.addBlankLine();
+        this._contents += '|';
+        headers.forEach((header) => {
+            this._contents += header + '|';
+        });
+        this.addBlankLine();
+        this._contents += '|';
+        headers.forEach((_) => {
+            this._contents += '---' + '|';
+        });
+        this.addBlankLine();
+    }
+    addTableRow(...columns) {
+        this._contents += '|';
+        columns.forEach((column) => {
+            this._contents += this._replaceInlineReferences(column) + '|';
+        });
+        this.addBlankLine();
+    }
+    addListItem(text) {
+        this._contents += `* ${text}`;
+    }
+    static replaceInlineLinks(text) {
+        // Parsing text to extract possible linking classes.
+        const possibleLinks = text.match(/<<.*?>>/g);
+        possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
+            const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
+            text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
+        });
+        // Parsing links using {@link ClassName} format
+        const linkFormatRegEx = '{@link (.*?)}';
+        const expression = new RegExp(linkFormatRegEx, 'gi');
+        let match;
+        const matches = [];
+        do {
+            match = expression.exec(text);
+            if (match) {
+                matches.push(match);
+            }
+        } while (match);
+        for (const currentMatch of matches) {
+            text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
+        }
+        return text;
+    }
+    static replaceInlineEmails(text) {
+        // Parsing links using {@link ClassName} format
+        const linkFormatRegEx = '{@email (.*?)}';
+        const expression = new RegExp(linkFormatRegEx, 'gi');
+        let match;
+        const matches = [];
+        do {
+            match = expression.exec(text);
+            if (match) {
+                matches.push(match);
+            }
+        } while (match);
+        for (const currentMatch of matches) {
+            text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
+        }
+        return text;
+    }
+    _replaceInlineReferences(text) {
+        text = MarkdownFile.replaceInlineLinks(text);
+        text = MarkdownFile.replaceInlineEmails(text);
+        return text;
+    }
+}
+exports.MarkdownFile = MarkdownFile;
+//# sourceMappingURL=markdown-file.js.map

package/lib/model/markdown-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-file.js","sourceRoot":"","sources":["../../src/model/markdown-file.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAC1C,kGAAyF;AAEzF,MAAa,YAAa,SAAQ,uBAAU;IAC1C,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;QAC9B,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;YAC9B,KAAK,IAAI,GAAG,CAAC;SACd;QAED,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE,UAAU,CAAC,CAAC;IAChD,CAAC;IAED,cAAc,CAAC,QAAQ,GAAG,MAAM;QAC9B,IAAI,CAAC,OAAO,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,YAAY;QACV,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,GAAG,OAAiB;QAClC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACpB,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,GAAG,OAAiB;QAC9B,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;QAChE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,SAAS,IAAI,KAAK,IAAI,EAAE,CAAC;IAChC,CAAC;IAES,MAAM,CAAC,kBAAkB,CAAC,IAAY;QAC9C,oDAAoD;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7C,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACtC,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3E,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvG,CAAC,CAAC,CAAC;QAEH,+CAA+C;QAC/C,MAAM,eAAe,GAAG,eAAe,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvG;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,MAAM,CAAC,mBAAmB,CAAC,IAAY;QAC/C,+CAA+C;QAC/C,MAAM,eAAe,GAAG,gBAAgB,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACzF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,wBAAwB,CAAC,IAAY;QAC3C,IAAI,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AArHD,oCAqHC"}

package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts

@@ -0,0 +1,8 @@
+import { DocComment } from '@cparra/apex-reflection';
+import { MarkdownFile } from '../markdown-file';
+interface DocCommentAware {
+    docComment?: DocComment;
+}
+export declare function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
+export declare function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
+export {};

package/lib/model/markdown-generation-util/doc-comment-annotation-util.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addCustomDocCommentAnnotations = exports.addMermaid = void 0;
+const class_file_generatorHelper_1 = require("../../transpiler/markdown/class-file-generatorHelper");
+function addMermaid(markdownFile, docCommentAware) {
+    var _a;
+    const mermaid = (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'mermaid');
+    if (!mermaid) {
+        return;
+    }
+    markdownFile.addBlankLine();
+    markdownFile.startCodeBlock('mermaid');
+    mermaid.bodyLines.forEach((line) => {
+        markdownFile.addText(line, false);
+    });
+    markdownFile.endCodeBlock();
+    markdownFile.addBlankLine();
+}
+exports.addMermaid = addMermaid;
+function addCustomDocCommentAnnotations(markdownFile, docCommentAware) {
+    var _a;
+    (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name !== 'description').filter((currentAnnotation) => currentAnnotation.name !== 'mermaid').forEach((currentAnnotation) => {
+        markdownFile.addBlankLine();
+        markdownFile.addText(buildDocAnnotationText(currentAnnotation));
+        markdownFile.addBlankLine();
+    });
+    function splitAndCapitalize(text) {
+        const words = text.split(/[-_]+/);
+        const capitalizedWords = [];
+        for (const word of words) {
+            capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
+        }
+        return capitalizedWords.join(' ');
+    }
+    function buildDocAnnotationText(annotation) {
+        let annotationBodyText = annotation.body;
+        if (annotation.name.toLowerCase() === 'see') {
+            annotationBodyText = class_file_generatorHelper_1.default.getFileLinkByTypeName(annotation.body);
+        }
+        return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
+    }
+}
+exports.addCustomDocCommentAnnotations = addCustomDocCommentAnnotations;
+//# sourceMappingURL=doc-comment-annotation-util.js.map

package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-comment-annotation-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/doc-comment-annotation-util.ts"],"names":[],"mappings":";;;AACA,qGAA4F;AAO5F,SAAgB,UAAU,CAAC,YAA0B,EAAE,eAAgC;;IACrF,MAAM,OAAO,GAAG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAC5G,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO;KACR;IAED,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACjC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAbD,gCAaC;AAED,SAAgB,8BAA8B,CAAC,YAA0B,EAAE,eAAgC;;IACzG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CACpC,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,EAC5F,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,SAAS,EACxF,OAAO,CAAC,CAAC,iBAAuC,EAAE,EAAE;QACnD,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAChE,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEL,SAAS,kBAAkB,CAAC,IAAY;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACrE;QACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,SAAS,sBAAsB,CAAC,UAAgC;QAC9D,IAAI,kBAAkB,GAAG,UAAU,CAAC,IAAI,CAAC;QACzC,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;YAC3C,kBAAkB,GAAG,oCAAwB,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACtF;QACD,OAAO,KAAK,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,kBAAkB,EAAE,CAAC;IAC5E,CAAC;AACH,CAAC;AA1BD,wEA0BC"}

package/lib/model/markdown-generation-util/field-declaration-util.d.ts

@@ -0,0 +1,3 @@
+import { MarkdownFile } from '../markdown-file';
+import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../inheritance';
+export declare function declareField(markdownFile: MarkdownFile, fields: FieldMirrorWithInheritance[] | PropertyMirrorWithInheritance[], startingHeadingLevel: number, grouped?: boolean): void;

package/lib/model/markdown-generation-util/field-declaration-util.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.declareField = void 0;
+function declareField(markdownFile, fields, startingHeadingLevel, grouped = false) {
+    markdownFile.addBlankLine();
+    fields.forEach((propertyModel) => {
+        addFieldSection(markdownFile, propertyModel, startingHeadingLevel, grouped);
+    });
+    markdownFile.addHorizontalRule();
+}
+exports.declareField = declareField;
+function addFieldSection(markdownFile, mirrorModel, startingHeadingLevel, grouped) {
+    var _a, _b, _c;
+    if (!grouped) {
+        markdownFile.addTitle(`\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``, startingHeadingLevel + 2);
+        markdownFile.addBlankLine();
+        if (mirrorModel.inherited) {
+            markdownFile.addText('*Inherited*');
+        }
+        mirrorModel.annotations.forEach((annotation) => {
+            markdownFile.addText(`\`${annotation.type.toUpperCase()}\` `);
+        });
+        if ((_a = mirrorModel.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+            markdownFile.addBlankLine();
+            markdownFile.addText(mirrorModel.docComment.description);
+        }
+        markdownFile.addBlankLine();
+    }
+    else {
+        let annotations = '';
+        const hasAnnotations = !!mirrorModel.annotations.length;
+        if (hasAnnotations) {
+            annotations += ' [';
+        }
+        mirrorModel.annotations.forEach((annotation) => {
+            annotations += `\`${annotation.type.toUpperCase()}\` `;
+        });
+        if (hasAnnotations) {
+            annotations += ']';
+        }
+        // If grouped we want to display these as a list
+        let description = '';
+        if ((_b = mirrorModel.docComment) === null || _b === void 0 ? void 0 : _b.description) {
+            description = ` - ${(_c = mirrorModel.docComment) === null || _c === void 0 ? void 0 : _c.description}`;
+        }
+        let listItemText = `\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``;
+        if (mirrorModel.inherited) {
+            listItemText += '(*Inherited*)';
+        }
+        listItemText += `${annotations} ${description}`;
+        markdownFile.addListItem(listItemText);
+        markdownFile.addBlankLine();
+    }
+}
+//# sourceMappingURL=field-declaration-util.js.map

package/lib/model/markdown-generation-util/field-declaration-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/field-declaration-util.ts"],"names":[],"mappings":";;;AAGA,SAAgB,YAAY,CAC1B,YAA0B,EAC1B,MAAsE,EACtE,oBAA4B,EAC5B,OAAO,GAAG,KAAK;IAEf,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QAC/B,eAAe,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AAZD,oCAYC;AAED,SAAS,eAAe,CACtB,YAA0B,EAC1B,WAA4B,EAC5B,oBAA4B,EAC5B,OAAgB;;IAEhB,IAAI,CAAC,OAAO,EAAE;QACZ,YAAY,CAAC,QAAQ,CACnB,KAAK,WAAW,CAAC,eAAe,IAAI,WAAW,CAAC,IAAI,UAAU,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EAC1G,oBAAoB,GAAG,CAAC,CACzB,CAAC;QACF,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,IAAI,WAAW,CAAC,SAAS,EAAE;YACzB,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SACrC;QAED,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7C,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE;YACvC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;SAC1D;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;SAAM;QACL,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC;QACxD,IAAI,cAAc,EAAE;YAClB,WAAW,IAAI,IAAI,CAAC;SACrB;QACD,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7C,WAAW,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC;QACzD,CAAC,CAAC,CAAC;QACH,IAAI,cAAc,EAAE;YAClB,WAAW,IAAI,GAAG,CAAC;SACpB;QAED,gDAAgD;QAChD,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE;YACvC,WAAW,GAAG,MAAM,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;SAC3D;QAED,IAAI,YAAY,GAAG,KAAK,WAAW,CAAC,eAAe,IAAI,WAAW,CAAC,IAAI,UAAU,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,CAAC;QAC9H,IAAI,WAAW,CAAC,SAAS,EAAE;YACzB,YAAY,IAAI,eAAe,CAAC;SACjC;QACD,YAAY,IAAI,GAAG,WAAW,IAAI,WAAW,EAAE,CAAC;QAEhD,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACvC,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;AACH,CAAC"}

package/lib/model/markdown-generation-util/index.d.ts

@@ -0,0 +1,3 @@
+export * from './type-declaration-util';
+export * from './method-declaration-util';
+export * from './field-declaration-util';

package/lib/model/markdown-generation-util/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./type-declaration-util"), exports);
+__exportStar(require("./method-declaration-util"), exports);
+__exportStar(require("./field-declaration-util"), exports);
+//# sourceMappingURL=index.js.map

package/lib/model/markdown-generation-util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,4DAA0C;AAC1C,2DAAyC"}

package/lib/model/markdown-generation-util/method-declaration-util.d.ts

@@ -0,0 +1,4 @@
+import { ConstructorMirror } from '@cparra/apex-reflection';
+import { MarkdownFile } from '../markdown-file';
+import { MethodMirrorWithInheritance } from '../inheritance';
+export declare function declareMethod(markdownFile: MarkdownFile, methods: ConstructorMirror[] | MethodMirrorWithInheritance[], startingHeadingLevel: number, className?: string): void;

package/lib/model/markdown-generation-util/method-declaration-util.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.declareMethod = void 0;
+const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
+function declareMethod(markdownFile, methods, startingHeadingLevel, className = '') {
+    methods.forEach((currentMethod) => {
+        var _a, _b;
+        const signatureName = isMethod(currentMethod)
+            ? `${currentMethod.typeReference.rawDeclaration} ${currentMethod.name}`
+            : className;
+        markdownFile.addTitle(`\`${buildSignature(currentMethod.access_modifier, signatureName, currentMethod)}\``, startingHeadingLevel + 2);
+        // Inheritance tag
+        if (isMethod(currentMethod)) {
+            const asMethodMirror = currentMethod;
+            if (asMethodMirror.inherited) {
+                markdownFile.addBlankLine();
+                markdownFile.addText('*Inherited*');
+                markdownFile.addBlankLine();
+            }
+        }
+        currentMethod.annotations.forEach((annotation) => {
+            markdownFile.addBlankLine();
+            markdownFile.addText(`\`${annotation.type.toUpperCase()}\``);
+        });
+        if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+            markdownFile.addBlankLine();
+            markdownFile.addText(currentMethod.docComment.description);
+            markdownFile.addBlankLine();
+        }
+        if (currentMethod.parameters.length) {
+            addParameters(markdownFile, currentMethod, startingHeadingLevel);
+        }
+        if (isMethod(currentMethod)) {
+            addReturns(markdownFile, currentMethod, startingHeadingLevel);
+        }
+        addThrowsBlock(markdownFile, currentMethod, startingHeadingLevel);
+        (0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, currentMethod);
+        (0, doc_comment_annotation_util_1.addMermaid)(markdownFile, currentMethod);
+        if ((_b = currentMethod.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) {
+            addExample(markdownFile, currentMethod, startingHeadingLevel);
+        }
+    });
+    markdownFile.addHorizontalRule();
+}
+exports.declareMethod = declareMethod;
+function buildSignature(accessModifier, name, parameterAware) {
+    let signature = `${name}(`;
+    if (isMethod(parameterAware) && parameterAware.memberModifiers.length) {
+        signature =
+            accessModifier +
+                ' ' +
+                parameterAware.memberModifiers.join(' ') +
+                ' ' +
+                signature;
+    }
+    else {
+        signature = accessModifier + ' ' + signature;
+    }
+    const signatureParameters = parameterAware.parameters.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`);
+    signature += signatureParameters.join(', ');
+    return `${signature})`;
+}
+function addParameters(markdownFile, methodModel, startingHeadingLevel) {
+    var _a, _b;
+    if (!((_a = methodModel.docComment) === null || _a === void 0 ? void 0 : _a.paramAnnotations.length)) {
+        // If there are no parameters defined in the docs then we don't want to display this section
+        return;
+    }
+    markdownFile.addTitle('Parameters', startingHeadingLevel + 3);
+    markdownFile.initializeTable('Param', 'Description');
+    (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.paramAnnotations.forEach((paramAnnotation) => {
+        const paramName = paramAnnotation.paramName;
+        const paramDescription = paramAnnotation.bodyLines.join(' ');
+        markdownFile.addTableRow(`\`${paramName}\``, paramDescription);
+    });
+    markdownFile.addBlankLine();
+}
+function addReturns(markdownFile, methodModel, startingHeadingLevel) {
+    var _a, _b;
+    if (!((_a = methodModel.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation)) {
+        return;
+    }
+    markdownFile.addTitle('Returns', startingHeadingLevel + 3);
+    markdownFile.initializeTable('Type', 'Description');
+    markdownFile.addTableRow(`\`${methodModel.typeReference.rawDeclaration}\``, (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.returnAnnotation.bodyLines.join(' '));
+    markdownFile.addBlankLine();
+}
+function addThrowsBlock(markdownFile, docCommentAware, startingHeadingLevel) {
+    var _a, _b;
+    if (!((_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.length)) {
+        return;
+    }
+    markdownFile.addTitle('Throws', startingHeadingLevel + 3);
+    markdownFile.initializeTable('Exception', 'Description');
+    (_b = docCommentAware.docComment) === null || _b === void 0 ? void 0 : _b.throwsAnnotations.forEach((annotation) => {
+        const exceptionName = annotation.exceptionName;
+        const exceptionDescription = annotation.bodyLines.join(' ');
+        markdownFile.addTableRow(`\`${exceptionName}\``, exceptionDescription);
+    });
+    markdownFile.addBlankLine();
+}
+function addExample(markdownFile, docCommentAware, startingHeadingLevel) {
+    var _a;
+    markdownFile.addTitle('Example', startingHeadingLevel + 3);
+    markdownFile.startCodeBlock();
+    (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.exampleAnnotation.bodyLines.forEach((line) => {
+        markdownFile.addText(line, false);
+    });
+    markdownFile.endCodeBlock();
+    markdownFile.addBlankLine();
+}
+function isMethod(method) {
+    return method.typeReference !== undefined;
+}
+//# sourceMappingURL=method-declaration-util.js.map

package/lib/model/markdown-generation-util/method-declaration-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"method-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/method-declaration-util.ts"],"names":[],"mappings":";;;AAGA,+EAA2F;AAG3F,SAAgB,aAAa,CAC3B,YAA0B,EAC1B,OAA4D,EAC5D,oBAA4B,EAC5B,SAAS,GAAG,EAAE;IAEd,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;QAChC,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;YAC3C,CAAC,CAAC,GAAI,aAA6C,CAAC,aAAa,CAAC,cAAc,IAC3E,aAA6C,CAAC,IACjD,EAAE;YACJ,CAAC,CAAC,SAAS,CAAC;QAEd,YAAY,CAAC,QAAQ,CACnB,KAAK,cAAc,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,EAAE,aAAa,CAAC,IAAI,EACpF,oBAAoB,GAAG,CAAC,CACzB,CAAC;QAEF,kBAAkB;QAClB,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC3B,MAAM,cAAc,GAAG,aAA4C,CAAC;YACpE,IAAI,cAAc,CAAC,SAAS,EAAE;gBAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;gBAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;gBACpC,YAAY,CAAC,YAAY,EAAE,CAAC;aAC7B;SACF;QAED,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC/C,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,WAAW,EAAE;YACzC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC3D,YAAY,CAAC,YAAY,EAAE,CAAC;SAC7B;QAED,IAAI,aAAa,CAAC,UAAU,CAAC,MAAM,EAAE;YACnC,aAAa,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;SAClE;QAED,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC3B,UAAU,CAAC,YAAY,EAAE,aAA4C,EAAE,oBAAoB,CAAC,CAAC;SAC9F;QAED,cAAc,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QAElE,IAAA,4DAA8B,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAE5D,IAAA,wCAAU,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAExC,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,iBAAiB,EAAE;YAC/C,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;SAC/D;IACH,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AA3DD,sCA2DC;AAUD,SAAS,cAAc,CAAC,cAAsB,EAAE,IAAY,EAAE,cAA8B;IAC1F,IAAI,SAAS,GAAG,GAAG,IAAI,GAAG,CAAC;IAC3B,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAK,cAA8C,CAAC,eAAe,CAAC,MAAM,EAAE;QACtG,SAAS;YACP,cAAc;gBACd,GAAG;gBACF,cAA8C,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;gBACzE,GAAG;gBACH,SAAS,CAAC;KACb;SAAM;QACL,SAAS,GAAG,cAAc,GAAG,GAAG,GAAG,SAAS,CAAC;KAC9C;IACD,MAAM,mBAAmB,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,CACvD,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CACjE,CAAC;IACF,SAAS,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,OAAO,GAAG,SAAS,GAAG,CAAC;AACzB,CAAC;AAED,SAAS,aAAa,CACpB,YAA0B,EAC1B,WAA4D,EAC5D,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,MAAM,CAAA,EAAE;QACpD,4FAA4F;QAC5F,OAAO;KACR;IAED,YAAY,CAAC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC9D,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAErD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;QACnE,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC;QAC5C,MAAM,gBAAgB,GAAG,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,YAAY,CAAC,WAAW,CAAC,KAAK,SAAS,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CACjB,YAA0B,EAC1B,WAAwC,EACxC,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAA,EAAE;QAC7C,OAAO;KACR;IAED,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,eAAe,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACpD,YAAY,CAAC,WAAW,CACtB,KAAK,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EACjD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAC7D,CAAC;IACF,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,cAAc,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAChH,IAAI,CAAC,CAAA,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,MAAM,CAAA,EAAE;QACzD,OAAO;KACR;IACD,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC1D,YAAY,CAAC,eAAe,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAEzD,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACnE,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC/C,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5D,YAAY,CAAC,WAAW,CAAC,KAAK,aAAa,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAC5G,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,cAAc,EAAE,CAAC;IAC9B,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACvE,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,QAAQ,CACf,MAAwE;IAExE,OAAQ,MAAsC,CAAC,aAAa,KAAK,SAAS,CAAC;AAC7E,CAAC"}

package/lib/model/markdown-generation-util/type-declaration-util.d.ts

@@ -0,0 +1,3 @@
+import { MarkdownFile } from '../markdown-file';
+import { Type } from '@cparra/apex-reflection';
+export declare function declareType(markdownFile: MarkdownFile, typeMirror: Type): void;

package/lib/model/markdown-generation-util/type-declaration-util.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.declareType = void 0;
+const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
+const types_repository_1 = require("../types-repository");
+function declareType(markdownFile, typeMirror) {
+    var _a;
+    typeMirror.annotations.forEach((currentAnnotation) => {
+        markdownFile.addBlankLine();
+        markdownFile.addText(`\`${currentAnnotation.type.toUpperCase()}\``);
+    });
+    if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
+        markdownFile.addBlankLine();
+        for (const currentLine of typeMirror.docComment.descriptionLines) {
+            markdownFile.addText(currentLine);
+        }
+        markdownFile.addBlankLine();
+    }
+    if (typeMirror.type_name === 'class') {
+        addInheritanceSectionForClass(typeMirror, markdownFile);
+    }
+    if (typeMirror.type_name === 'interface') {
+        addInheritanceSectionForInterface(typeMirror, markdownFile);
+    }
+    (0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, typeMirror);
+    (0, doc_comment_annotation_util_1.addMermaid)(markdownFile, typeMirror);
+}
+exports.declareType = declareType;
+function addInheritanceSectionForClass(typeMirror, markdownFile) {
+    const typeAsClass = typeMirror;
+    if (typeAsClass.extended_class) {
+        markdownFile.addBlankLine();
+        markdownFile.addText('**Inheritance**');
+        markdownFile.addBlankLine();
+        addParent(markdownFile, typeAsClass);
+        markdownFile.addText(typeMirror.name);
+        markdownFile.addBlankLine();
+    }
+    if (typeAsClass.implemented_interfaces.length) {
+        markdownFile.addBlankLine();
+        markdownFile.addText('**Implemented types**');
+        markdownFile.addBlankLine();
+        for (let i = 0; i < typeAsClass.implemented_interfaces.length; i++) {
+            const currentName = typeAsClass.implemented_interfaces[i];
+            markdownFile.addLink(currentName);
+            if (i < typeAsClass.implemented_interfaces.length - 1) {
+                markdownFile.addText(', ');
+            }
+        }
+        markdownFile.addBlankLine();
+    }
+}
+function addInheritanceSectionForInterface(typeMirror, markdownFile) {
+    const typeAsInterface = typeMirror;
+    if (typeAsInterface.extended_interfaces.length) {
+        markdownFile.addBlankLine();
+        markdownFile.addText('**Extended types**');
+        markdownFile.addBlankLine();
+        for (let i = 0; i < typeAsInterface.extended_interfaces.length; i++) {
+            const currentName = typeAsInterface.extended_interfaces[i];
+            markdownFile.addLink(currentName);
+            if (i < typeAsInterface.extended_interfaces.length - 1) {
+                markdownFile.addText(', ');
+            }
+        }
+    }
+}
+function addParent(markdownFile, classMirror) {
+    if (!classMirror.extended_class) {
+        return;
+    }
+    const parentType = types_repository_1.TypesRepository.getInstance().getFromScopedByName(classMirror.extended_class);
+    if (!parentType) {
+        return;
+    }
+    if (parentType.type_name === 'class') {
+        addParent(markdownFile, parentType);
+    }
+    markdownFile.addLink(parentType.name);
+    markdownFile.addText(' > ');
+}
+//# sourceMappingURL=type-declaration-util.js.map

package/lib/model/markdown-generation-util/type-declaration-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/type-declaration-util.ts"],"names":[],"mappings":";;;AACA,+EAA2F;AAE3F,0DAAsD;AAEtD,SAAgB,WAAW,CAAC,YAA0B,EAAE,UAAgB;;IACtE,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,iBAA6B,EAAE,EAAE;QAC/D,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,IAAI,MAAA,UAAU,CAAC,UAAU,0CAAE,gBAAgB,EAAE;QAC3C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,UAAU,CAAC,gBAAgB,EAAE;YAChE,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SACnC;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;IAED,IAAI,UAAU,CAAC,SAAS,KAAK,OAAO,EAAE;QACpC,6BAA6B,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;KACzD;IAED,IAAI,UAAU,CAAC,SAAS,KAAK,WAAW,EAAE;QACxC,iCAAiC,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;KAC7D;IAED,IAAA,4DAA8B,EAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAEzD,IAAA,wCAAU,EAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AACvC,CAAC;AAzBD,kCAyBC;AAED,SAAS,6BAA6B,CAAC,UAAgB,EAAE,YAA0B;IACjF,MAAM,WAAW,GAAG,UAAyB,CAAC;IAC9C,IAAI,WAAW,CAAC,cAAc,EAAE;QAC9B,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACxC,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACrC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtC,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;IAED,IAAI,WAAW,CAAC,sBAAsB,CAAC,MAAM,EAAE;QAC7C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;QAC9C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,sBAAsB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAClE,MAAM,WAAW,GAAG,WAAW,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;YAC1D,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG,WAAW,CAAC,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACrD,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aAC5B;SACF;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;AACH,CAAC;AAED,SAAS,iCAAiC,CAAC,UAAgB,EAAE,YAA0B;IACrF,MAAM,eAAe,GAAG,UAA6B,CAAC;IACtD,IAAI,eAAe,CAAC,mBAAmB,CAAC,MAAM,EAAE;QAC9C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC3C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACnE,MAAM,WAAW,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAC3D,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG,eAAe,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtD,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aAC5B;SACF;KACF;AACH,CAAC;AAED,SAAS,SAAS,CAAC,YAA0B,EAAE,WAAwB;IACrE,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE;QAC/B,OAAO;KACR;IAED,MAAM,UAAU,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IACjG,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IAED,IAAI,UAAU,CAAC,SAAS,KAAK,OAAO,EAAE;QACpC,SAAS,CAAC,YAAY,EAAE,UAAyB,CAAC,CAAC;KACpD;IAED,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC"}

package/lib/model/markdown-home-file.d.ts

@@ -0,0 +1,11 @@
+import { Type } from '@cparra/apex-reflection';
+import { MarkdownFile } from './markdown-file';
+export declare class MarkdownHomeFile extends MarkdownFile {
+    fileName: string;
+    types: Type[];
+    constructor(fileName: string, types: Type[], headerContent?: string);
+    private addTypeEntries;
+    private addTypeEntry;
+    private group;
+    private getClassGroup;
+}

package/lib/model/markdown-home-file.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownHomeFile = void 0;
+const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
+const markdown_file_1 = require("./markdown-file");
+const string_utils_1 = require("../util/string-utils");
+const settings_1 = require("../settings");
+class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
+    constructor(fileName, types, headerContent) {
+        super(fileName, '');
+        this.fileName = fileName;
+        this.types = types;
+        if (headerContent) {
+            this.addText(headerContent);
+        }
+        this.addTitle(settings_1.Settings.getInstance().getTitle());
+        this.addTypeEntries(types);
+    }
+    addTypeEntries(types) {
+        const groupedClasses = this.group(types);
+        groupedClasses.forEach((value, key) => {
+            this.addTitle(key, 2);
+            value.forEach((typeMirror) => {
+                this.addTypeEntry(typeMirror);
+            });
+        });
+    }
+    addTypeEntry(typeMirror) {
+        var _a;
+        this.addBlankLine();
+        this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror), 3);
+        this.addBlankLine();
+        if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
+            const description = typeMirror.docComment.descriptionLines.reduce((previous, current) => previous + current + '\n', '');
+            this.addText((0, string_utils_1.truncate)(description, 300));
+            this.addBlankLine();
+        }
+    }
+    group(classes) {
+        return classes.reduce((groups, currentClass) => {
+            const key = this.getClassGroup(currentClass);
+            const group = groups.get(key) || [];
+            group.push(currentClass);
+            groups.set(key, group);
+            return groups;
+        }, new Map());
+    }
+    getClassGroup(classModel) {
+        var _a, _b, _c;
+        return ((_c = (_b = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group')) === null || _b === void 0 ? void 0 : _b.body) !== null && _c !== void 0 ? _c : settings_1.Settings.getInstance().getDefaultGroupName());
+    }
+}
+exports.MarkdownHomeFile = MarkdownHomeFile;
+//# sourceMappingURL=markdown-home-file.js.map

package/lib/model/markdown-home-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-home-file.js","sourceRoot":"","sources":["../../src/model/markdown-home-file.ts"],"names":[],"mappings":";;;AACA,kGAAyF;AACzF,mDAA+C;AAC/C,uDAAgD;AAChD,0CAAuC;AAEvC,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAmB,QAAgB,EAAS,KAAa,EAAE,aAAsB;QAC/E,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QADH,aAAQ,GAAR,QAAQ,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAQ;QAEvD,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QACD,IAAI,CAAC,QAAQ,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEO,cAAc,CAAC,KAAa;QAClC,MAAM,cAAc,GAAwB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9D,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;YACpD,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtB,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC3B,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,UAAgB;;QACnC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,oCAAwB,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,IAAI,MAAA,UAAU,CAAC,UAAU,0CAAE,gBAAgB,EAAE;YAC3C,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAC/D,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,QAAQ,GAAG,OAAO,GAAG,IAAI,EAChD,EAAE,CACH,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,IAAA,uBAAQ,EAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,YAAY,EAAE,CAAC;SACrB;IACH,CAAC;IAEO,KAAK,CAAC,OAAe;QAC3B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAW,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,UAAgB;;QACpC,OAAO,CACL,MAAA,MAAA,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,0CAAE,IAAI,mCAC1F,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAC7C,CAAC;IACJ,CAAC;CACF;AAnDD,4CAmDC"}