@cparra/apexdocs 2.24.0 → 2.25.0-alpha.0

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

@@ -1,20 +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);
+"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/method-declaration-util.d.ts

@@ -1,4 +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;
+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

@@ -1,115 +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;
-}
+"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/type-declaration-util.d.ts

@@ -1,3 +1,3 @@
-import { MarkdownFile } from '../markdown-file';
-import { Type } from '@cparra/apex-reflection';
-export declare function declareType(markdownFile: MarkdownFile, typeMirror: Type): void;
+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

@@ -1,82 +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(' > ');
-}
+"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-home-file.d.ts

@@ -1,11 +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;
-}
+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

@@ -1,54 +1,57 @@
-"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;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownHomeFile = void 0;
+const class_file_generatorHelper_1 = __importDefault(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

@@ -1 +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"}
+{"version":3,"file":"markdown-home-file.js","sourceRoot":"","sources":["../../src/model/markdown-home-file.ts"],"names":[],"mappings":";;;;;;AACA,mHAAyF;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"}