@cparra/apexdocs 2.24.0 → 2.25.0-alpha.0

package/lib/transpiler/markdown/class-file-generatorHelper.js

@@ -1,56 +1,75 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const types_repository_1 = require("../../model/types-repository");
-const settings_1 = require("../../settings");
-const state_1 = require("../../service/state");
-const factory_1 = require("../factory");
-class ClassFileGeneratorHelper {
-    static getSanitizedGroup(classModel) {
-        return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
-    }
-    static getFileLink(classModel) {
-        var _a;
-        const documentationRoot = (_a = settings_1.Settings.getInstance().getRootDir()) !== null && _a !== void 0 ? _a : '';
-        const directoryRoot = `${documentationRoot}${this.getDirectoryRoot(classModel)}`;
-        const fullClassName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${classModel.name}`;
-        return `[${fullClassName}](${directoryRoot}${fullClassName}.md)`;
-    }
-    static getFileLinkByTypeName(typeName) {
-        const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
-        if (!type) {
-            // If the type is not found, we return a Markdown hyperlink with whatever we received.
-            return `[${typeName}](${typeName})`;
-        }
-        return this.getFileLink(type);
-    }
-    static getDirectoryRoot(classModel) {
-        // root-relative links start from the root by using a leading '/'
-        const generator = settings_1.Settings.getInstance().targetGenerator;
-        if (factory_1.TypeTranspilerFactory.get(generator).getLinkingStrategy() === 'root-relative') {
-            return `/${this.getSanitizedGroup(classModel)}/`;
-        }
-        // path-relative links traverse the directory structure
-        const typeBeingProcessed = state_1.default.getInstance().getTypeBeingProcessed();
-        if (typeBeingProcessed) {
-            if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
-                // If the types the same groups then we simply link directly to that file
-                return './';
-            }
-            else {
-                // If the types have different groups, then we have to go up a directory
-                return `../${this.getSanitizedGroup(classModel)}/`;
-            }
-        }
-        else {
-            // If nothing is being processed, then we assume we are at the root and links should include the groups
-            return `./${this.getSanitizedGroup(classModel)}/`;
-        }
-    }
-    static getClassGroup(classModel) {
-        var _a, _b;
-        const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
-        return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : settings_1.Settings.getInstance().getDefaultGroupName();
-    }
-}
-exports.default = ClassFileGeneratorHelper;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_repository_1 = require("../../model/types-repository");
+const settings_1 = require("../../settings");
+const state_1 = __importDefault(require("../../service/state"));
+const factory_1 = require("../factory");
+class ClassFileGeneratorHelper {
+    static getSanitizedGroup(classModel) {
+        return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
+    }
+    static getFileLink(classModel) {
+        const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(classModel);
+        return `[${fullClassName}](${fileLink})`;
+    }
+    static getFileLinkTuple(classModel) {
+        var _a;
+        const documentationRoot = (_a = settings_1.Settings.getInstance().getRootDir()) !== null && _a !== void 0 ? _a : '';
+        const directoryRoot = `${documentationRoot}${this.getDirectoryRoot(classModel)}`;
+        const fullClassName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${classModel.name}`;
+        return [fullClassName, `${directoryRoot}${fullClassName}.md`];
+    }
+    static getFileLinkByTypeName(typeName) {
+        const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
+        if (!type) {
+            // If the type is not found, we return a Markdown hyperlink with whatever we received.
+            return `[${typeName}](${typeName})`;
+        }
+        return this.getFileLink(type);
+    }
+    static getRenderableLinkByTypeName(typeName) {
+        const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
+        if (!type) {
+            // If the type is not found, we return the type name as a string.
+            return typeName;
+        }
+        const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(type);
+        return {
+            title: fullClassName,
+            url: fileLink,
+        };
+    }
+    static getDirectoryRoot(classModel) {
+        // root-relative links start from the root by using a leading '/'
+        const generator = settings_1.Settings.getInstance().targetGenerator;
+        if (factory_1.TypeTranspilerFactory.get(generator).getLinkingStrategy() === 'root-relative') {
+            return `/${this.getSanitizedGroup(classModel)}/`;
+        }
+        // path-relative links traverse the directory structure
+        const typeBeingProcessed = state_1.default.getInstance().getTypeBeingProcessed();
+        if (typeBeingProcessed) {
+            if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
+                // If the types the same groups then we simply link directly to that file
+                return './';
+            }
+            else {
+                // If the types have different groups, then we have to go up a directory
+                return `../${this.getSanitizedGroup(classModel)}/`;
+            }
+        }
+        else {
+            // If nothing is being processed, then we assume we are at the root and links should include the groups
+            return `./${this.getSanitizedGroup(classModel)}/`;
+        }
+    }
+    static getClassGroup(classModel) {
+        var _a, _b;
+        const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
+        return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : settings_1.Settings.getInstance().getDefaultGroupName();
+    }
+}
+exports.default = ClassFileGeneratorHelper;
 //# sourceMappingURL=class-file-generatorHelper.js.map

package/lib/transpiler/markdown/class-file-generatorHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,+CAAwC;AACxC,wCAAmD;AAEnD,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;;QACxC,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,IAAI,aAAa,KAAK,aAAa,GAAG,aAAa,MAAM,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YACjF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SAClD;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAC7E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,uGAAuG;YACvG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAnDD,2CAmDC"}
+{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;;;;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,gEAAwC;AACxC,wCAAmD;AAGnD,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxF,OAAO,IAAI,aAAa,KAAK,QAAQ,GAAG,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;;QAC9C,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,2BAA2B,CAAC,QAAgB;QACxD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,iEAAiE;YACjE,OAAO,QAAQ,CAAC;SACjB;QAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClF,OAAO;YACL,KAAK,EAAE,aAAa;YACpB,GAAG,EAAE,QAAQ;SACd,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YACjF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SAClD;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAC7E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,uGAAuG;YACvG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAtED,2CAsEC"}

package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts

@@ -1,6 +1,6 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
-export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
-    homeFileName(): string;
-    getLinkingStrategy(): LinkingStrategy;
-}
+import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { LinkingStrategy } from '../../processor-type-transpiler';
+export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
+    homeFileName(): string;
+    getLinkingStrategy(): LinkingStrategy;
+}

package/lib/transpiler/markdown/docsify/docsify-docs-processor.js

@@ -1,13 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
-class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
-    homeFileName() {
-        return 'README';
-    }
-    getLinkingStrategy() {
-        return 'root-relative';
-    }
-}
-exports.default = DocsifyDocsProcessor;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
+class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
+    homeFileName() {
+        return 'README';
+    }
+    getLinkingStrategy() {
+        return 'root-relative';
+    }
+}
+exports.default = DocsifyDocsProcessor;
 //# sourceMappingURL=docsify-docs-processor.js.map

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts

@@ -1,11 +1,11 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { Type } from '@cparra/apex-reflection';
-import { LinkingStrategy } from '../../processor-type-transpiler';
-export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
-    homeFileName(): string;
-    onBeforeProcess: (types: Type[]) => void;
-    onProcess(type: Type): void;
-    get frontMatterForHomeFile(): string;
-    getFrontMatterHeader(type: Type): string;
-    getLinkingStrategy(): LinkingStrategy;
-}
+import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { Type } from '@cparra/apex-reflection';
+import { LinkingStrategy } from '../../processor-type-transpiler';
+export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
+    homeFileName(): string;
+    onBeforeProcess: (types: Type[]) => void;
+    onProcess(type: Type): void;
+    get frontMatterForHomeFile(): string;
+    getFrontMatterHeader(type: Type): string;
+    getLinkingStrategy(): LinkingStrategy;
+}

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js

@@ -1,51 +1,51 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.JekyllDocsProcessor = void 0;
-const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
-const markdown_home_file_1 = require("../../../model/markdown-home-file");
-const markdown_type_file_1 = require("../../../model/markdown-type-file");
-const settings_1 = require("../../../settings");
-class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
-    constructor() {
-        super(...arguments);
-        this.onBeforeProcess = (types) => {
-            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
-        };
-    }
-    homeFileName() {
-        return 'index';
-    }
-    onProcess(type) {
-        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
-    }
-    get frontMatterForHomeFile() {
-        return '---\nlayout: default\n---';
-    }
-    getFrontMatterHeader(type) {
-        var _a;
-        const headerLines = ['---'];
-        // "layout: default" is a required front matter header for Jekyll
-        headerLines.push('layout: default');
-        // Add any additional front matter headers that might have been configured in the settings
-        const targetType = {
-            name: type.name,
-            typeName: type.type_name,
-            accessModifier: type.access_modifier,
-            group: type.group,
-            description: (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description,
-        };
-        const configuredHeaders = settings_1.Settings.getInstance().frontMatterHeader(targetType);
-        if (configuredHeaders) {
-            configuredHeaders.forEach((header) => {
-                headerLines.push(header);
-            });
-        }
-        headerLines.push('---');
-        return headerLines.join('\n');
-    }
-    getLinkingStrategy() {
-        return 'path-relative';
-    }
-}
-exports.JekyllDocsProcessor = JekyllDocsProcessor;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JekyllDocsProcessor = void 0;
+const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
+const markdown_home_file_1 = require("../../../model/markdown-home-file");
+const markdown_type_file_1 = require("../../../model/markdown-type-file");
+const settings_1 = require("../../../settings");
+class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
+    constructor() {
+        super(...arguments);
+        this.onBeforeProcess = (types) => {
+            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
+        };
+    }
+    homeFileName() {
+        return 'index';
+    }
+    onProcess(type) {
+        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
+    }
+    get frontMatterForHomeFile() {
+        return '---\nlayout: default\n---';
+    }
+    getFrontMatterHeader(type) {
+        var _a;
+        const headerLines = ['---'];
+        // "layout: default" is a required front matter header for Jekyll
+        headerLines.push('layout: default');
+        // Add any additional front matter headers that might have been configured in the settings
+        const targetType = {
+            name: type.name,
+            typeName: type.type_name,
+            accessModifier: type.access_modifier,
+            group: type.group,
+            description: (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description,
+        };
+        const configuredHeaders = settings_1.Settings.getInstance().frontMatterHeader(targetType);
+        if (configuredHeaders) {
+            configuredHeaders.forEach((header) => {
+                headerLines.push(header);
+            });
+        }
+        headerLines.push('---');
+        return headerLines.join('\n');
+    }
+    getLinkingStrategy() {
+        return 'path-relative';
+    }
+}
+exports.JekyllDocsProcessor = JekyllDocsProcessor;
 //# sourceMappingURL=jekyll-docsProcessor.js.map

package/lib/transpiler/markdown/markdown-transpiler-base.d.ts

@@ -1,11 +1,11 @@
-import ProcessorTypeTranspiler from '../processor-type-transpiler';
-import { Type } from '@cparra/apex-reflection';
-import { FileContainer } from '../file-container';
-export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
-    protected readonly _fileContainer: FileContainer;
-    constructor();
-    abstract homeFileName(): string;
-    fileBuilder(): FileContainer;
-    onBeforeProcess: (types: Type[]) => void;
-    onProcess(type: Type): void;
-}
+import ProcessorTypeTranspiler from '../processor-type-transpiler';
+import { Type } from '@cparra/apex-reflection';
+import { FileContainer } from '../file-container';
+export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
+    protected readonly _fileContainer: FileContainer;
+    constructor();
+    abstract homeFileName(): string;
+    fileBuilder(): FileContainer;
+    onBeforeProcess: (types: Type[]) => void;
+    onProcess(type: Type): void;
+}

package/lib/transpiler/markdown/markdown-transpiler-base.js

@@ -1,24 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MarkdownTranspilerBase = void 0;
-const processor_type_transpiler_1 = require("../processor-type-transpiler");
-const file_container_1 = require("../file-container");
-const markdown_home_file_1 = require("../../model/markdown-home-file");
-const markdown_type_file_1 = require("../../model/markdown-type-file");
-class MarkdownTranspilerBase extends processor_type_transpiler_1.default {
-    constructor() {
-        super();
-        this.onBeforeProcess = (types) => {
-            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
-        };
-        this._fileContainer = new file_container_1.FileContainer();
-    }
-    fileBuilder() {
-        return this._fileContainer;
-    }
-    onProcess(type) {
-        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type));
-    }
-}
-exports.MarkdownTranspilerBase = MarkdownTranspilerBase;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownTranspilerBase = void 0;
+const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
+const file_container_1 = require("../file-container");
+const markdown_home_file_1 = require("../../model/markdown-home-file");
+const markdown_type_file_1 = require("../../model/markdown-type-file");
+class MarkdownTranspilerBase extends processor_type_transpiler_1.default {
+    constructor() {
+        super();
+        this.onBeforeProcess = (types) => {
+            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
+        };
+        this._fileContainer = new file_container_1.FileContainer();
+    }
+    fileBuilder() {
+        return this._fileContainer;
+    }
+    onProcess(type) {
+        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type));
+    }
+}
+exports.MarkdownTranspilerBase = MarkdownTranspilerBase;
 //# sourceMappingURL=markdown-transpiler-base.js.map

package/lib/transpiler/markdown/markdown-transpiler-base.js.map

@@ -1 +1 @@
-{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;AAAA,4EAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}
+{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}

package/lib/transpiler/markdown/plain-markdown/class-template.d.ts

@@ -0,0 +1 @@
+export declare const classMarkdownTemplate: string;

package/lib/transpiler/markdown/plain-markdown/class-template.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.classMarkdownTemplate = void 0;
+exports.classMarkdownTemplate = `
+# {{name}} Class
+{{#if classModifier}}
+\`{{classModifier}}\`
+{{/if}}
+
+{{> typeLevelApexDocPartialTemplate}}
+
+{{#if extends}}
+**Extends**
+{{extends}}
+{{/if}}
+
+{{#if implements}}
+**Implements**
+{{#each implements}}
+{{this}}{{#unless @last}}, {{/unless}}
+{{/each}}
+{{/if}}
+
+{{#if fields}}
+{{> fieldsPartialTemplate}}
+{{/if}}
+
+{{#if constructors}}
+{{> constructorsPartialTemplate}}
+{{/if}}
+
+{{#if methods}}
+{{> methodsPartialTemplate}}
+{{/if}}
+`.trim();
+//# sourceMappingURL=class-template.js.map

package/lib/transpiler/markdown/plain-markdown/class-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/class-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BpC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts

@@ -0,0 +1 @@
+export declare const constructorsPartialTemplate: string;

package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructorsPartialTemplate = void 0;
+exports.constructorsPartialTemplate = `
+## Constructors
+{{#each constructors}}
+### \`{{title}}\`
+
+{{#> documentablePartialTemplate}}
+
+### Signature
+\`\`\`apex
+{{signature}}
+\`\`\` 
+
+{{#if parameters}}
+### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+{{#each parameters}}
+| {{name}} | {{type}} | {{description}} |
+{{/each}}
+{{/if}}
+
+{{#if throws}}
+### Throws
+{{#each throws}}
+{{this.type}}: {{this.description}}
+
+{{/each}}
+{{/if}}
+
+{{/documentablePartialTemplate}}
+
+{{#unless @last}}---{{/unless}}
+{{/each}}
+
+`.trim();
+//# sourceMappingURL=constructors-partial-template.js.map

package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constructors-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/constructors-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkC1C,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts

@@ -0,0 +1 @@
+export declare const documentablePartialTemplate: string;

package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.documentablePartialTemplate = void 0;
+exports.documentablePartialTemplate = `
+{{#each annotations}}
+\`{{this}}\`
+{{/each}}
+
+{{description}}
+
+{{#each customTags}}
+**{{splitAndCapitalize name}}** {{description}}
+
+{{/each}}
+
+{{> @partial-block}}
+
+{{{mermaid}}}
+
+{{#if example}}
+##{{#if isInner}}#{{/if}} Example
+{{{example}}}
+{{/if}}
+`.trim();
+//# sourceMappingURL=documentable-partial-template.js.map

package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentable-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/documentable-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;CAoB1C,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts

@@ -0,0 +1 @@
+export declare const enumMarkdownTemplate: string;

package/lib/transpiler/markdown/plain-markdown/enum-template.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enumMarkdownTemplate = void 0;
+exports.enumMarkdownTemplate = `
+# {{name}} Enum
+
+{{> typeLevelApexDocPartialTemplate}}
+
+## Enum Values
+{{#each values}}
+### {{value}}
+{{description}}
+{{/each}}
+`.trim();
+//# sourceMappingURL=enum-template.js.map

package/lib/transpiler/markdown/plain-markdown/enum-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/enum-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG;;;;;;;;;;CAUnC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts

@@ -0,0 +1 @@
+export declare const fieldsPartialTemplate: string;

package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fieldsPartialTemplate = void 0;
+exports.fieldsPartialTemplate = `
+## Fields
+{{#each fields}}
+### \`\{{name}}\`
+
+{{#if inherited}}
+*Inherited*
+{{/if}}
+
+{{#> documentablePartialTemplate}}
+
+#### Type
+{{type}}
+
+{{/documentablePartialTemplate}}
+
+{{#unless @last}}---{{/unless}}
+
+{{/each}}
+`.trim();
+//# sourceMappingURL=fieldsPartialTemplate.js.map

package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldsPartialTemplate.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;CAmBpC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts

@@ -0,0 +1 @@
+export declare const interfaceMarkdownTemplate: string;

package/lib/transpiler/markdown/plain-markdown/interface-template.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.interfaceMarkdownTemplate = void 0;
+exports.interfaceMarkdownTemplate = `
+# {{name}} Interface
+
+{{> typeLevelApexDocPartialTemplate}}
+
+{{#if extends}}
+**Extends**
+{{#each extends}}
+{{this}}{{#unless @last}}, {{/unless}}
+{{/each}}
+{{/if}}
+
+{{#if methods}}
+{{> methodsPartialTemplate}}
+{{/if}}
+`.trim();
+//# sourceMappingURL=interface-template.js.map

package/lib/transpiler/markdown/plain-markdown/interface-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/interface-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,yBAAyB,GAAG;;;;;;;;;;;;;;;CAexC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts

@@ -0,0 +1 @@
+export declare const methodsPartialTemplate: string;