@cparra/apexdocs 1.13.7 → 1.13.8

package/docs/single-file/Sample-Classes/SampleClass.md

@@ -0,0 +1,115 @@
+---
+layout: default
+---
+# SampleClass class
+
+`NamespaceAccessible`
+
+This is a class description.
+
+## Related
+
+SampleInterface
+
+
+SampleClass2
+
+---
+## Constructors
+### `SampleClass()`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass without any arguments.
+#### Example
+```
+<pre>
+SampleClass sampleInstance = new SampleClass();
+```
+
+### `SampleClass(String argument)`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass with an argument.
+#### Parameters
+
+| Param | Description |
+| ----- | ----------- |
+|`argument` |  Some argument. Of type String. |
+
+---
+## Properties
+
+### `AnotherProp` → `Decimal`
+
+`NamespaceAccessible`
+
+This is a Decimal property.
+
+### `MyProp` → `String`
+
+`NamespaceAccessible`
+
+This is a String property.
+
+---
+## Methods
+### `call()` → `void`
+
+`NamespaceAccessible`
+
+Calls the method. This methods allows you to call it.
+
+### `testMethod(String argument)` → `String`
+
+`NamespaceAccessible`
+
+Executes commands based on the passed in argument.
+
+#### Example
+```
+<pre>
+String result = SampleClass.testMethod();
+System.debug(result);
+```
+
+---
+## Inner Classes
+
+### SampleClass.AnotherInnerClass class
+
+Inner class belonging to SampleClass.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---
+### SampleClass.InnerClass class
+
+Inner class belonging to SampleClass.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---

package/lib/AsJsDocsProcessor.d.ts

@@ -1,6 +1,6 @@
 import DocsProcessor from './DocsProcessor';
 import JsHelper from './JsHelper';
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 export default class AsJsDocsProcessor extends DocsProcessor {
     process(classModel: ClassModel, outputDir: string): void;
     generateDocsForClass(generator: JsHelper, classModel: ClassModel): void;

package/lib/ClassFileGeneratorHelper.d.ts

@@ -1,4 +1,4 @@
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 export default class ClassFileGeneratorHelper {
     static getSanitizedGroup(classModel: ClassModel): string;
     static getFileLink(classModel: ClassModel, forRelatedReference?: boolean): string;

package/lib/ClassFileGeneratorHelper.test.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ClassFileGeneratorHelper_1 = require("./ClassFileGeneratorHelper");
-const ClassModel_1 = require("./model/ClassModel");
+const ClassModel_1 = require("./Model/ClassModel");
 const Settings_1 = require("./Settings");
 test('that getSanitizedGroup returns the same string when there is nothing to sanitize', () => {
     const testClass = new ClassModel_1.default();

package/lib/{command → Command}/Generate.d.ts

@@ -1,2 +1,2 @@
-import ClassModel from '../model/ClassModel';
+import ClassModel from '../Model/ClassModel';
 export declare function generate(sourceDirectory: string, recursive?: boolean, scope?: string[], outputDir?: string, targetGenerator?: string, configPath?: string, group?: boolean): ClassModel[];

package/lib/{command → Command}/Generate.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const path = require("path");
 const Settings_1 = require("../Settings");
-const FileParser_1 = require("../parser/FileParser");
+const FileParser_1 = require("../Parser/FileParser");
 const DocsifyDocsProcessor_1 = require("../DocsifyDocsProcessor");
 const JekyllDocsProcessor_1 = require("../JekyllDocsProcessor");
 const AsJsDocsProcessor_1 = require("../AsJsDocsProcessor");

package/lib/{command → Command}/__test__/Generte.test.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const Generate_1 = require("../Generate");
-const FileParser_1 = require("../../parser/FileParser");
+const FileParser_1 = require("../../Parser/FileParser");
 jest.mock('fs');
-jest.mock('../../parser/FileParser');
+jest.mock('../../Parser/FileParser');
 beforeEach(() => {
     FileParser_1.default.mockClear();
 });

package/lib/DocsProcessor.d.ts

@@ -1,4 +1,4 @@
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 export default abstract class DocsProcessor {
     onBeforeProcess(classes: ClassModel[], outputDir: string): void;
     abstract process(cModel: ClassModel, outputDir: string): void;

package/lib/FileManager.d.ts

@@ -1,4 +1,4 @@
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 export default class FileManager {
     classModels: ClassModel[];
     constructor(classModels: ClassModel[]);

package/lib/MarkdownDocsProcessor.d.ts

@@ -1,6 +1,6 @@
 import DocsProcessor from './DocsProcessor';
 import MarkdownHelper from './MarkdownHelper';
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 export default abstract class MarkdownDocsProcessor extends DocsProcessor {
     private classes;
     abstract getHomeFileName(): string;

package/lib/MarkdownHelper.d.ts

@@ -1,4 +1,4 @@
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 export default class MarkdownHelper {
     contents: string;
     classes: ClassModel[];

package/lib/{parser → Parser}/ClassParser.d.ts

@@ -1,4 +1,4 @@
-import ClassModel from '../model/ClassModel';
+import ClassModel from '../Model/ClassModel';
 export default class ClassParser {
     getClass(strLine: string, lstComments: string[], iLine: number, parent?: ClassModel): ClassModel;
     private fillClassModel;

package/lib/{parser → Parser}/ClassParser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const ClassModel_1 = require("../model/ClassModel");
+const ClassModel_1 = require("../Model/ClassModel");
 const sanitize = require("sanitize-filename-ts");
 class ClassParser {
     getClass(strLine, lstComments, iLine, parent) {

package/lib/{parser → Parser}/EnumParser.d.ts

@@ -1,4 +1,4 @@
-import EnumModel from '../model/EnumModel';
+import EnumModel from '../Model/EnumModel';
 export default class EnumParser {
     getEnum(strLine: string, lstComments: string[], iLine: number): EnumModel;
     fillEnumModel(enumModel: EnumModel, nameLine: string, lstComments: string[], iLine: number): void;

package/lib/{parser → Parser}/EnumParser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const EnumModel_1 = require("../model/EnumModel");
+const EnumModel_1 = require("../Model/EnumModel");
 class EnumParser {
     getEnum(strLine, lstComments, iLine) {
         const enumModel = new EnumModel_1.default();

package/lib/{parser → Parser}/FileParser.d.ts

@@ -1,4 +1,4 @@
-import ClassModel from '../model/ClassModel';
+import ClassModel from '../Model/ClassModel';
 export default class FileParser {
     parseFileContents(rawFileContents: string): ClassModel | null;
     splitAndClean(rawFileContents: string): string[];

package/lib/{parser → Parser}/MethodParser.d.ts

@@ -1,4 +1,4 @@
-import MethodModel from '../model/MethodModel';
+import MethodModel from '../Model/MethodModel';
 export default class MethodParser {
     getMethod(parentClassName: string, strLine: string, lstComments: string[], iLine: number): MethodModel;
     fillMethodModel(parentClassName: string, mModel: MethodModel, name: string, lstComments: string[], iLine: number): void;

package/lib/{parser → Parser}/MethodParser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const MethodModel_1 = require("../model/MethodModel");
+const MethodModel_1 = require("../Model/MethodModel");
 class MethodParser {
     getMethod(parentClassName, strLine, lstComments, iLine) {
         const mModel = new MethodModel_1.default();

package/lib/{parser → Parser}/PropertyParser.d.ts

@@ -1,4 +1,4 @@
-import PropertyModel from '../model/PropertyModel';
+import PropertyModel from '../Model/PropertyModel';
 export default class PropertyParser {
     getProperty(strLine: string, lstComments: string[], iLine: number): PropertyModel;
     fillPropertyModel(propertyModel: PropertyModel, name: string, lstComments: string[], iLine: number): void;

package/lib/{parser → Parser}/PropertyParser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const PropertyModel_1 = require("../model/PropertyModel");
+const PropertyModel_1 = require("../Model/PropertyModel");
 class PropertyParser {
     getProperty(strLine, lstComments, iLine) {
         const propertyModel = new PropertyModel_1.default();

package/lib/application/Apexdocs.d.ts

@@ -0,0 +1,11 @@
+import { ReflectionResult } from '@cparra/apex-reflection';
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+export declare class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate(): void;
+    static _reflectionWithLogger: (declarationBody: string) => ReflectionResult;
+}

package/lib/application/Apexdocs.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const apex_file_reader_1 = require("../service/apex-file-reader");
+const file_system_1 = require("../service/file-system");
+const apex_reflection_1 = require("@cparra/apex-reflection");
+const logger_1 = require("../util/logger");
+const manifest_factory_1 = require("../service/manifest-factory");
+const parser_1 = require("../service/parser");
+const settings_1 = require("../settings");
+const transpiler_1 = require("../transpiler/transpiler");
+const file_writer_1 = require("../service/file-writer");
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate() {
+        const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
+        const manifest = manifest_factory_1.createManifest(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
+        const filteredManifest = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
+        logger_1.Logger.log(`Parsed ${filteredManifest.length} files`);
+        const processor = settings_1.Settings.getInstance().typeTranspiler;
+        transpiler_1.default.generate(filteredManifest, processor);
+        const generatedFiles = processor.fileBuilder().files();
+        file_writer_1.FileWriter.write(generatedFiles, (fileName) => {
+            logger_1.Logger.log(`${fileName} processed.`);
+        });
+    }
+}
+exports.Apexdocs = Apexdocs;
+Apexdocs._reflectionWithLogger = (declarationBody) => {
+    var _a;
+    const result = apex_reflection_1.reflect(declarationBody);
+    if (result.error) {
+        logger_1.Logger.log(`Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
+    }
+    return result;
+};
+//# sourceMappingURL=Apexdocs.js.map

package/lib/application/Apexdocs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAAoE;AACpE,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AAEpD;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,iCAAc,CAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE3F,MAAM,gBAAgB,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;QAEvG,eAAM,CAAC,GAAG,CAAC,UAAU,gBAAgB,CAAC,MAAM,QAAQ,CAAC,CAAC;QACtD,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC;QACxD,oBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QACvD,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,aAAa,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;;AAjBH,4BA0BC;AAPQ,8BAAqB,GAAG,CAAC,eAAuB,EAAoB,EAAE;;IAC3E,MAAM,MAAM,GAAG,yBAAO,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,GAAG,CAAC,iBAAiB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACtD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/cli/generate.js

@@ -2,7 +2,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const yargs = require("yargs");
-const Generate_1 = require("../command/Generate");
+const Generate_1 = require("../Command/Generate");
 const FileManager_1 = require("../FileManager");
 const argv = yargs.options({
     sourceDir: {

package/lib/cli/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAyD;AACzD,sDAAmD;AAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,0HAA0H;KAC7H;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;QAC9B,QAAQ,EACN,mHAAmH;KACtH;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;CAC1D,CAAC,CAAC;AAEH,mBAAQ,CAAC,QAAQ,EAAE,CAAC"}

package/lib/index.d.ts

@@ -1 +1 @@
-export * from './command/Generate';
+export * from './Command/Generate';

package/lib/index.js

@@ -3,4 +3,4 @@ function __export(m) {
     for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
 }
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./command/Generate"));
+__export(require("./Command/Generate"));

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,gDAA2C"}

package/lib/model/file.d.ts

@@ -0,0 +1,10 @@
+export declare abstract class File {
+    fileName: string;
+    dir: string;
+    _contents: string;
+    constructor(fileName: string, dir: string);
+    abstract fileExtension(): string;
+    get body(): string;
+    addText(text: string, encodeHtml?: boolean): void;
+    addBlankLine(): void;
+}

package/lib/model/file.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const html_entities_1 = require("html-entities");
+class File {
+    constructor(fileName, dir) {
+        this.fileName = fileName;
+        this.dir = dir;
+        this._contents = '';
+    }
+    get body() {
+        return this._contents;
+    }
+    addText(text, encodeHtml = true) {
+        const textToAdd = encodeHtml ? html_entities_1.encode(text) : text;
+        this._contents += textToAdd;
+        this.addBlankLine();
+    }
+    addBlankLine() {
+        this._contents += '\n';
+    }
+}
+exports.File = File;
+//# sourceMappingURL=file.js.map

package/lib/model/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/model/file.ts"],"names":[],"mappings":";;AAAA,iDAAuC;AAEvC,MAAsB,IAAI;IAGxB,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,sBAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AApBD,oBAoBC"}

package/lib/model/manifest-diff.d.ts

@@ -0,0 +1,5 @@
+import Manifest from './manifest';
+import * as jsondiffpatch from 'jsondiffpatch';
+export declare class ManifestDiff {
+    static build(originalManifest: Manifest, newManifest: Manifest): jsondiffpatch.Delta | undefined;
+}

package/lib/model/manifest-diff.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const jsondiffpatch = require("jsondiffpatch");
+class ManifestDiff {
+    static build(originalManifest, newManifest) {
+        return jsondiffpatch.diff(originalManifest, newManifest);
+    }
+}
+exports.ManifestDiff = ManifestDiff;
+//# sourceMappingURL=manifest-diff.js.map

package/lib/model/manifest-diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-diff.js","sourceRoot":"","sources":["../../src/model/manifest-diff.ts"],"names":[],"mappings":";;AACA,+CAA+C;AAE/C,MAAa,YAAY;IACvB,MAAM,CAAC,KAAK,CAAC,gBAA0B,EAAE,WAAqB;QAC5D,OAAO,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;CACF;AAJD,oCAIC"}

package/lib/model/manifest.d.ts

@@ -0,0 +1,22 @@
+import { Type, Annotation } from '@cparra/apex-reflection';
+declare type AccessAware = {
+    access_modifier: string;
+} & {
+    annotations: Annotation[];
+};
+/**
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
+ */
+export default class Manifest {
+    types: Type[];
+    isForInnerTypes: boolean;
+    /**
+     * 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: Type[], isForInnerTypes?: boolean);
+    filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
+    filterAccessibleModifier(accessAware: AccessAware[], modifiers: string[]): AccessAware[];
+}
+export {};

package/lib/model/manifest.js

@@ -0,0 +1,42 @@
+"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(accessAware, modifiers) {
+        return accessAware.filter((currentType) => {
+            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":";;AAIA;;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,aAAa,CAAC,CAAC;SACnC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wBAAwB,CAAC,WAA0B,EAAE,SAAmB;QACtE,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE;YACxC,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;AApDD,2BAoDC"}

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

@@ -0,0 +1,10 @@
+import { File } from './file';
+export declare class MarkdownFile extends File {
+    fileExtension(): string;
+    addTitle(text: string, level?: number): void;
+    startCodeBlock(): void;
+    endCodeBlock(): void;
+    addHorizontalRule(): void;
+    initializeTable(...headers: string[]): void;
+    addTableRow(...columns: string[]): void;
+}

package/lib/model/markdown-file.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const file_1 = require("./file");
+class MarkdownFile extends file_1.File {
+    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();
+    }
+    startCodeBlock() {
+        this._contents += '```';
+        const sourceLanguage = 'apex';
+        this._contents += sourceLanguage;
+        this.addBlankLine();
+    }
+    endCodeBlock() {
+        this._contents += '```';
+        this.addBlankLine();
+    }
+    addHorizontalRule() {
+        this._contents += '---';
+        this.addBlankLine();
+    }
+    initializeTable(...headers) {
+        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 += column + '|';
+        });
+    }
+}
+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,iCAA8B;AAE9B,MAAa,YAAa,SAAQ,WAAI;IACpC,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;IAED,cAAc;QACZ,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,MAAM,cAAc,GAAG,MAAM,CAAC;QAC9B,IAAI,CAAC,SAAS,IAAI,cAAc,CAAC;QACjC,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,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,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,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AArDD,oCAqDC"}

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

@@ -0,0 +1,3 @@
+import { MarkdownFile } from '../markdown-file';
+import { FieldMirror, PropertyMirror } from '@cparra/apex-reflection';
+export declare function declareField(title: string, markdownFile: MarkdownFile, fields: FieldMirror[] | PropertyMirror[], startingHeadingLevel: number): void;

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function declareField(title, markdownFile, fields, startingHeadingLevel) {
+    markdownFile.addTitle(title, startingHeadingLevel + 1);
+    markdownFile.addBlankLine();
+    fields
+        .sort((propA, propB) => {
+        if (propA.name < propB.name)
+            return -1;
+        if (propA.name > propB.name)
+            return 1;
+        return 0;
+    })
+        .forEach((propertyModel) => {
+        addFieldSection(markdownFile, propertyModel, startingHeadingLevel);
+    });
+    markdownFile.addHorizontalRule();
+}
+exports.declareField = declareField;
+function addFieldSection(markdownFile, propertyModel, startingHeadingLevel) {
+    var _a;
+    markdownFile.addTitle(`\`${propertyModel.name}\` → \`${propertyModel.type}\``, startingHeadingLevel + 2);
+    propertyModel.annotations.forEach((annotation) => {
+        markdownFile.addBlankLine();
+        markdownFile.addText(`\`${annotation.type.toUpperCase()}\``);
+    });
+    if ((_a = propertyModel.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+        markdownFile.addBlankLine();
+        markdownFile.addText(propertyModel.docComment.description);
+    }
+    markdownFile.addBlankLine();
+}
+//# sourceMappingURL=field-declaration-util.js.map