@cparra/apexdocs 2.24.0 → 2.25.0-alpha.0

package/examples/plain-markdown/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "plain-markdown",
+  "scripts": {
+    "docs:clean": "rimraf ./README.md",
+    "docs:build": "ts-node ../../src/cli/generate.ts",
+    "docs:gen": "npm run docs:clean && npm run docs:build"
+  },
+  "devDependencies": {
+    "ts-node": "^10.9.2"
+  },
+  "dependencies": {
+    "rimraf": "^5.0.7"
+  },
+  "apexdocs": {
+    "sourceDir": "force-app",
+    "targetGenerator": "plain-markdown",
+    "scope": ["global", "public", "protected", "private", "namespaceaccessible"],
+    "namespace": "ns",
+    "singleFile": true,
+    "templateFilePath": "template.md",
+    "fileName": "README",
+    "targetDir": "."
+  }
+}

package/examples/plain-markdown/sfdx-project.json

@@ -0,0 +1,12 @@
+{
+  "packageDirectories": [
+    {
+      "path": "force-app",
+      "default": true
+    }
+  ],
+  "name": "plain-markdown",
+  "namespace": "",
+  "sfdcLoginUrl": "https://login.salesforce.com",
+  "sourceApiVersion": "59.0"
+}

package/examples/plain-markdown/template.md

@@ -0,0 +1,3 @@
+# Template file
+
+{{{api_docs}}}

package/jest.config.js

@@ -1,5 +1,5 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  modulePathIgnorePatterns: ['<rootDir>/lib/'],
-};
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ['<rootDir>/lib/'],
+};

package/lib/adapters/apex-types.d.ts

@@ -0,0 +1,5 @@
+import { ClassMirror, EnumMirror, InterfaceMirror } from '@cparra/apex-reflection';
+import { ClassSource, EnumSource, InterfaceSource } from '../templating/types';
+export declare function enumTypeToEnumSource(enumType: EnumMirror): EnumSource;
+export declare function interfaceTypeToInterfaceSource(interfaceType: InterfaceMirror): InterfaceSource;
+export declare function classTypeToClassSource(classType: ClassMirror): ClassSource;

package/lib/adapters/apex-types.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.classTypeToClassSource = exports.interfaceTypeToInterfaceSource = exports.enumTypeToEnumSource = void 0;
+const documentables_1 = require("./documentables");
+const references_1 = require("./references");
+const methods_and_constructors_1 = require("./methods-and-constructors");
+const fields_and_properties_1 = require("./fields-and-properties");
+function baseTypeAdapter(type) {
+    function extractAnnotationBody(type, annotationName) {
+        var _a, _b;
+        return (_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName)) === null || _b === void 0 ? void 0 : _b.body;
+    }
+    function extractSeeAnnotations(type) {
+        var _a, _b;
+        return ((_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name.toLowerCase() === 'see').map((currentAnnotation) => currentAnnotation.body)) !== null && _b !== void 0 ? _b : []);
+    }
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDocumentable)(type)), { accessModifier: type.access_modifier, name: type.name, group: extractAnnotationBody(type, 'group'), author: extractAnnotationBody(type, 'author'), date: extractAnnotationBody(type, 'date'), sees: extractSeeAnnotations(type).map(references_1.linkFromTypeNameGenerator) });
+}
+function enumTypeToEnumSource(enumType) {
+    return Object.assign(Object.assign({ __type: 'enum' }, baseTypeAdapter(enumType)), { values: enumType.values.map((value) => {
+            var _a;
+            return (Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_a = value.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines)), { value: value.name }));
+        }) });
+}
+exports.enumTypeToEnumSource = enumTypeToEnumSource;
+function interfaceTypeToInterfaceSource(interfaceType) {
+    return Object.assign(Object.assign({ __type: 'interface' }, baseTypeAdapter(interfaceType)), { extends: interfaceType.extended_interfaces.map(references_1.linkFromTypeNameGenerator), methods: interfaceType.methods.map(methods_and_constructors_1.adaptMethod) });
+}
+exports.interfaceTypeToInterfaceSource = interfaceTypeToInterfaceSource;
+function classTypeToClassSource(classType) {
+    return Object.assign(Object.assign({ __type: 'class' }, baseTypeAdapter(classType)), { classModifier: classType.classModifier, sharingModifier: classType.sharingModifier, implements: classType.implemented_interfaces.map(references_1.linkFromTypeNameGenerator), extends: classType.extended_class ? (0, references_1.linkFromTypeNameGenerator)(classType.extended_class) : undefined, methods: classType.methods.map(methods_and_constructors_1.adaptMethod), constructors: classType.constructors.map((constructor) => (0, methods_and_constructors_1.adaptConstructor)(classType.name, constructor)), fields: classType.fields.map((field) => (0, fields_and_properties_1.adaptField)(field)) });
+}
+exports.classTypeToClassSource = classTypeToClassSource;
+//# sourceMappingURL=apex-types.js.map

package/lib/adapters/apex-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apex-types.js","sourceRoot":"","sources":["../../src/adapters/apex-types.ts"],"names":[],"mappings":";;;AAEA,mDAAsE;AACtE,6CAAyD;AAEzD,yEAA2E;AAC3E,mEAAqD;AAErD,SAAS,eAAe,CAAC,IAAgD;IACvE,SAAS,qBAAqB,CAAC,IAAU,EAAE,cAAsB;;QAC/D,OAAO,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACtC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAC/E,0CAAE,IAAI,CAAC;IACV,CAAC;IAED,SAAS,qBAAqB,CAAC,IAAU;;QACvC,OAAO,CACL,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CACzB,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAC5E,GAAG,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,mCAAI,EAAE,CAC5D,CAAC;IACJ,CAAC;IAED,uCACK,IAAA,iCAAiB,EAAC,IAAI,CAAC,KAC1B,cAAc,EAAE,IAAI,CAAC,eAAe,EACpC,IAAI,EAAE,IAAI,CAAC,IAAI,EACf,KAAK,EAAE,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,EAC3C,MAAM,EAAE,qBAAqB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAC7C,IAAI,EAAE,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,EACzC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,sCAAyB,CAAC,IAChE;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAAC,QAAoB;IACvD,qCACE,MAAM,EAAE,MAAM,IACX,eAAe,CAAC,QAAQ,CAAC,KAC5B,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;YAAC,OAAA,iCAClC,IAAA,gCAAgB,EAAC,MAAA,KAAK,CAAC,UAAU,0CAAE,gBAAgB,CAAC,KACvD,KAAK,EAAE,KAAK,CAAC,IAAI,IACjB,CAAA;SAAA,CAAC,IACH;AACJ,CAAC;AATD,oDASC;AAED,SAAgB,8BAA8B,CAAC,aAA8B;IAC3E,qCACE,MAAM,EAAE,WAAW,IAChB,eAAe,CAAC,aAAa,CAAC,KACjC,OAAO,EAAE,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,sCAAyB,CAAC,EACzE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAW,CAAC,IAC/C;AACJ,CAAC;AAPD,wEAOC;AAED,SAAgB,sBAAsB,CAAC,SAAsB;IAC3D,qCACE,MAAM,EAAE,OAAO,IACZ,eAAe,CAAC,SAAS,CAAC,KAC7B,aAAa,EAAE,SAAS,CAAC,aAAa,EACtC,eAAe,EAAE,SAAS,CAAC,eAAe,EAC1C,UAAU,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,sCAAyB,CAAC,EAC3E,OAAO,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,IAAA,sCAAyB,EAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,EACnG,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAW,CAAC,EAC3C,YAAY,EAAE,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAA,2CAAgB,EAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,EACxG,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,kCAAU,EAAC,KAAmC,CAAC,CAAC,IACxF;AACJ,CAAC;AAZD,wDAYC"}

package/lib/adapters/documentables.d.ts

@@ -0,0 +1,6 @@
+import { DocumentableSource, RenderableContent } from '../templating/types';
+import { Describable, Documentable } from './types';
+export declare function adaptDescribable(describable: Describable): {
+    description?: RenderableContent[];
+};
+export declare function adaptDocumentable(documentable: Documentable): DocumentableSource;

package/lib/adapters/documentables.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptDocumentable = exports.adaptDescribable = void 0;
+const references_1 = require("./references");
+const type_utils_1 = require("./type-utils");
+function adaptDescribable(describable) {
+    function describableToRenderableContent(describable) {
+        if (!describable) {
+            return;
+        }
+        return (describable
+            .map((line) => [
+            ...(0, references_1.replaceInlineReferences)(line),
+            {
+                type: 'empty-line',
+            },
+        ])
+            .flatMap((line) => line)
+            // If the last element is an empty line, remove it
+            .filter((line, index, lines) => !((0, type_utils_1.isEmptyLine)(line) && index === lines.length - 1)));
+    }
+    return {
+        description: describableToRenderableContent(describable),
+    };
+}
+exports.adaptDescribable = adaptDescribable;
+function adaptDocumentable(documentable) {
+    var _a, _b, _c;
+    function extractCustomTags(type) {
+        var _a, _b;
+        const baseTags = ['description', 'group', 'author', 'date', 'see', 'example', 'mermaid', 'throws', 'exception'];
+        return ((_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => !baseTags.includes(currentAnnotation.name.toLowerCase())).map((currentAnnotation) => (Object.assign(Object.assign({}, adaptDescribable(currentAnnotation.bodyLines)), { name: currentAnnotation.name })))) !== null && _b !== void 0 ? _b : []);
+    }
+    function extractAnnotationBodyLines(type, annotationName) {
+        var _a, _b;
+        return (_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName)) === null || _b === void 0 ? void 0 : _b.bodyLines;
+    }
+    return Object.assign(Object.assign({}, adaptDescribable((_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines)), { annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()), customTags: extractCustomTags(documentable), mermaid: extractAnnotationBodyLines(documentable, 'mermaid'), example: (_c = (_b = documentable.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) === null || _c === void 0 ? void 0 : _c.bodyLines });
+}
+exports.adaptDocumentable = adaptDocumentable;
+//# sourceMappingURL=documentables.js.map

package/lib/adapters/documentables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentables.js","sourceRoot":"","sources":["../../src/adapters/documentables.ts"],"names":[],"mappings":";;;AAEA,6CAAuD;AACvD,6CAA2C;AAE3C,SAAgB,gBAAgB,CAAC,WAAwB;IACvD,SAAS,8BAA8B,CAAC,WAAwB;QAC9D,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO;SACR;QAED,OAAO,CACL,WAAW;aACR,GAAG,CAAsB,CAAC,IAAI,EAAE,EAAE,CAAC;YAClC,GAAG,IAAA,oCAAuB,EAAC,IAAI,CAAC;YAChC;gBACE,IAAI,EAAE,YAAY;aACnB;SACF,CAAC;aACD,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;YACxB,kDAAkD;aACjD,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAA,wBAAW,EAAC,IAAI,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACtF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,WAAW,EAAE,8BAA8B,CAAC,WAAW,CAAC;KACzD,CAAC;AACJ,CAAC;AAvBD,4CAuBC;AAED,SAAgB,iBAAiB,CAAC,YAA0B;;IAC1D,SAAS,iBAAiB,CAAC,IAAkB;;QAC3C,MAAM,QAAQ,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEhH,OAAO,CACL,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CACzB,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACtF,GAAG,CAAY,CAAC,iBAAiB,EAAE,EAAE,CAAC,iCAClC,gBAAgB,CAAC,iBAAiB,CAAC,SAAS,CAAC,KAChD,IAAI,EAAE,iBAAiB,CAAC,IAAI,IAC5B,CAAC,mCAAI,EAAE,CACZ,CAAC;IACJ,CAAC;IAED,SAAS,0BAA0B,CAAC,IAAkB,EAAE,cAAsB;;QAC5E,OAAO,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACtC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAC/E,0CAAE,SAAS,CAAC;IACf,CAAC;IAED,uCACK,gBAAgB,CAAC,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,CAAC,KAC9D,WAAW,EAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACxF,UAAU,EAAE,iBAAiB,CAAC,YAAY,CAAC,EAC3C,OAAO,EAAE,0BAA0B,CAAC,YAAY,EAAE,SAAS,CAAC,EAC5D,OAAO,EAAE,MAAA,MAAA,YAAY,CAAC,UAAU,0CAAE,iBAAiB,0CAAE,SAAS,IAC9D;AACJ,CAAC;AA3BD,8CA2BC"}

package/lib/adapters/fields-and-properties.d.ts

@@ -0,0 +1,3 @@
+import { FieldMirrorWithInheritance } from '../model/inheritance';
+import { FieldSource } from '../templating/types';
+export declare function adaptField(field: FieldMirrorWithInheritance): FieldSource;

package/lib/adapters/fields-and-properties.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptField = void 0;
+const documentables_1 = require("./documentables");
+const references_1 = require("./references");
+function adaptField(field) {
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDocumentable)(field)), { name: field.name, type: (0, references_1.linkFromTypeNameGenerator)(field.typeReference.rawDeclaration), inherited: field.inherited, accessModifier: field.access_modifier });
+}
+exports.adaptField = adaptField;
+//# sourceMappingURL=fields-and-properties.js.map

package/lib/adapters/fields-and-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields-and-properties.js","sourceRoot":"","sources":["../../src/adapters/fields-and-properties.ts"],"names":[],"mappings":";;;AAEA,mDAAoD;AACpD,6CAAyD;AAEzD,SAAgB,UAAU,CAAC,KAAiC;IAC1D,uCACK,IAAA,iCAAiB,EAAC,KAAK,CAAC,KAC3B,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,IAAI,EAAE,IAAA,sCAAyB,EAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,EACnE,SAAS,EAAE,KAAK,CAAC,SAAS,EAC1B,cAAc,EAAE,KAAK,CAAC,eAAe,IACrC;AACJ,CAAC;AARD,gCAQC"}

package/lib/adapters/methods-and-constructors.d.ts

@@ -0,0 +1,4 @@
+import { ConstructorMirror, MethodMirror } from '@cparra/apex-reflection';
+import { ConstructorSource, MethodSource } from '../templating/types';
+export declare function adaptMethod(method: MethodMirror): MethodSource;
+export declare function adaptConstructor(typeName: string, constructor: ConstructorMirror): ConstructorSource;

package/lib/adapters/methods-and-constructors.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptConstructor = exports.adaptMethod = void 0;
+const documentables_1 = require("./documentables");
+const references_1 = require("./references");
+function adaptMethod(method) {
+    var _a, _b, _c;
+    function buildTitle(method) {
+        const { name, parameters } = method;
+        const parametersString = parameters.map((param) => param.name).join(', ');
+        return `${name}(${parametersString})`;
+    }
+    function buildSignature(method) {
+        const { access_modifier, typeReference, name, memberModifiers } = method;
+        const parameters = method.parameters
+            .map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
+            .join(', ');
+        const members = memberModifiers.length > 0 ? `${memberModifiers.join(' ')} ` : '';
+        return `${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`;
+    }
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDocumentable)(method)), { title: buildTitle(method), signature: buildSignature(method), returnType: Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_b = (_a = method.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation) === null || _b === void 0 ? void 0 : _b.bodyLines)), { type: (0, references_1.linkFromTypeNameGenerator)(method.typeReference.rawDeclaration) }), throws: (_c = method.docComment) === null || _c === void 0 ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown)), parameters: method.parameters.map((param) => mapParameters(method, param)), inherited: method.inherited });
+}
+exports.adaptMethod = adaptMethod;
+function adaptConstructor(typeName, constructor) {
+    var _a;
+    function buildTitle(name, constructor) {
+        const { parameters } = constructor;
+        const parametersString = parameters.map((param) => param.name).join(', ');
+        return `${name}(${parametersString})`;
+    }
+    function buildSignature(name, constructor) {
+        const { access_modifier } = constructor;
+        const parameters = constructor.parameters
+            .map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
+            .join(', ');
+        return `${access_modifier} ${name}(${parameters})`;
+    }
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDocumentable)(constructor)), { title: buildTitle(typeName, constructor), signature: buildSignature(typeName, constructor), parameters: constructor.parameters.map((param) => mapParameters(constructor, param)), throws: (_a = constructor.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown)) });
+}
+exports.adaptConstructor = adaptConstructor;
+function mapParameters(documentable, param) {
+    var _a;
+    const paramAnnotation = (_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.paramAnnotations.find((pa) => pa.paramName.toLowerCase() === param.name.toLowerCase());
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(paramAnnotation === null || paramAnnotation === void 0 ? void 0 : paramAnnotation.bodyLines)), { name: param.name, type: (0, references_1.linkFromTypeNameGenerator)(param.typeReference.rawDeclaration) });
+}
+function mapThrows(thrown) {
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(thrown.bodyLines)), { type: (0, references_1.linkFromTypeNameGenerator)(thrown.exceptionName) });
+}
+//# sourceMappingURL=methods-and-constructors.js.map

package/lib/adapters/methods-and-constructors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods-and-constructors.js","sourceRoot":"","sources":["../../src/adapters/methods-and-constructors.ts"],"names":[],"mappings":";;;AAGA,mDAAsE;AACtE,6CAAyD;AAGzD,SAAgB,WAAW,CAAC,MAAoB;;IAC9C,SAAS,UAAU,CAAC,MAAmC;QACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACpC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,MAAmC;QACzD,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACzE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU;aACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClF,OAAO,GAAG,eAAe,IAAI,OAAO,GAAG,aAAa,CAAC,cAAc,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IAC/F,CAAC;IAED,uCACK,IAAA,iCAAiB,EAAC,MAAM,CAAC,KAC5B,KAAK,EAAE,UAAU,CAAC,MAAqC,CAAC,EACxD,SAAS,EAAE,cAAc,CAAC,MAAqC,CAAC,EAChE,UAAU,kCACL,IAAA,gCAAgB,EAAC,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,gBAAgB,0CAAE,SAAS,CAAC,KACnE,IAAI,EAAE,IAAA,sCAAyB,EAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAEtE,MAAM,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAC/E,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAC1E,SAAS,EAAG,MAAsC,CAAC,SAAS,IAC5D;AACJ,CAAC;AA5BD,kCA4BC;AAED,SAAgB,gBAAgB,CAAC,QAAgB,EAAE,WAA8B;;IAC/E,SAAS,UAAU,CAAC,IAAY,EAAE,WAA8B;QAC9D,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QACnC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,IAAY,EAAE,WAA8B;QAClE,MAAM,EAAE,eAAe,EAAE,GAAG,WAAW,CAAC;QACxC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU;aACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,GAAG,eAAe,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IACrD,CAAC;IAED,uCACK,IAAA,iCAAiB,EAAC,WAAW,CAAC,KACjC,KAAK,EAAE,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,EACxC,SAAS,EAAE,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,EAChD,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,EACpF,MAAM,EAAE,MAAA,WAAW,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IACpF;AACJ,CAAC;AAtBD,4CAsBC;AAED,SAAS,aAAa,CAAC,YAA0B,EAAE,KAAsB;;IACvE,MAAM,eAAe,GAAG,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,CAAC,IAAI,CACpE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAChE,CAAC;IACF,uCACK,IAAA,gCAAgB,EAAC,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,SAAS,CAAC,KAC/C,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,IAAI,EAAE,IAAA,sCAAyB,EAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,IACnE;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,MAAwB;IACzC,uCACK,IAAA,gCAAgB,EAAC,MAAM,CAAC,SAAS,CAAC,KACrC,IAAI,EAAE,IAAA,sCAAyB,EAAC,MAAM,CAAC,aAAa,CAAC,IACrD;AACJ,CAAC"}

package/lib/adapters/references.d.ts

@@ -0,0 +1,5 @@
+import { RenderableContent, StringOrLink } from '../templating/types';
+export type GetRenderableContentByTypeName = (typeName: string) => StringOrLink;
+export declare const linkFromTypeNameGenerator: GetRenderableContentByTypeName;
+export declare function replaceInlineReferences(text: string, linkReplacer?: GetRenderableContentByTypeName, emailReplacer?: GetRenderableContentByTypeName): RenderableContent[];
+export declare function replaceInlineEmails(renderableContents: RenderableContent[], getLinkByTypeName: GetRenderableContentByTypeName): RenderableContent[];

package/lib/adapters/references.js

@@ -0,0 +1,82 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceInlineEmails = exports.replaceInlineReferences = exports.linkFromTypeNameGenerator = void 0;
+const class_file_generatorHelper_1 = __importDefault(require("../transpiler/markdown/class-file-generatorHelper"));
+exports.linkFromTypeNameGenerator = class_file_generatorHelper_1.default.getRenderableLinkByTypeName;
+function defaultGetEmailByReference(email) {
+    return {
+        title: email,
+        url: `mailto:${email}`,
+    };
+}
+function replaceInlineReferences(text, linkReplacer = exports.linkFromTypeNameGenerator, emailReplacer = defaultGetEmailByReference) {
+    return replaceInlineEmails(replaceInlineLinks([text], linkReplacer), emailReplacer);
+}
+exports.replaceInlineReferences = replaceInlineReferences;
+function replaceInlineLinks(renderableContents, getLinkByTypeName) {
+    return renderableContents.flatMap((renderableContent) => inlineLinkContent(renderableContent, getLinkByTypeName));
+}
+function inlineLinkContent(renderableContent, getLinkByTypeName) {
+    if (typeof renderableContent !== 'string') {
+        return [renderableContent];
+    }
+    const text = renderableContent;
+    // Matches either `<<ClassName>>` or `{@link ClassName}`
+    const linkFormatRegEx = '{@link (.*?)}|<<([^>]+)>>';
+    const matches = match(linkFormatRegEx, text);
+    return createRenderableContents(matches, text, getLinkByTypeName);
+}
+function replaceInlineEmails(renderableContents, getLinkByTypeName) {
+    return renderableContents.flatMap((renderableContent) => inlineEmailContent(renderableContent, getLinkByTypeName));
+}
+exports.replaceInlineEmails = replaceInlineEmails;
+function inlineEmailContent(renderableContent, getLinkByTypeName) {
+    if (typeof renderableContent !== 'string') {
+        return [renderableContent];
+    }
+    const text = renderableContent;
+    // Parsing references using the format '{@email email}'
+    const linkFormatRegEx = '{@email (.*?)}';
+    const matches = match(linkFormatRegEx, text);
+    return createRenderableContents(matches, text, getLinkByTypeName);
+}
+function match(regex, text) {
+    const expression = new RegExp(regex, 'gi');
+    let match;
+    const matches = [];
+    do {
+        match = expression.exec(text);
+        if (match) {
+            matches.push(match);
+        }
+    } while (match);
+    return matches;
+}
+function createRenderableContents(matches, text, linker) {
+    if (matches.length === 0) {
+        return [text];
+    }
+    const result = [];
+    let lastIndex = 0;
+    for (const match of matches) {
+        const index = match.index;
+        const length = match[0].length;
+        // loop through the matches (skip the first one, which is the full match)
+        // until we find the first capturing group that has a value
+        const capturedGroup = match.slice(1).find((group) => group);
+        if (!capturedGroup) {
+            continue;
+        }
+        result.push(text.slice(lastIndex, index));
+        result.push(linker(capturedGroup));
+        lastIndex = index + length;
+    }
+    if (lastIndex < text.length) {
+        result.push(text.slice(lastIndex));
+    }
+    return result;
+}
+//# sourceMappingURL=references.js.map

package/lib/adapters/references.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"references.js","sourceRoot":"","sources":["../../src/adapters/references.ts"],"names":[],"mappings":";;;;;;AAAA,mHAAyF;AAK5E,QAAA,yBAAyB,GACpC,oCAAwB,CAAC,2BAA2B,CAAC;AAEvD,SAAS,0BAA0B,CAAC,KAAa;IAC/C,OAAO;QACL,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,UAAU,KAAK,EAAE;KACvB,CAAC;AACJ,CAAC;AAED,SAAgB,uBAAuB,CACrC,IAAY,EACZ,eAA+C,iCAAyB,EACxE,gBAAgD,0BAA0B;IAE1E,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,EAAE,aAAa,CAAC,CAAC;AACtF,CAAC;AAND,0DAMC;AAED,SAAS,kBAAkB,CACzB,kBAAuC,EACvC,iBAAiD;IAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACpH,CAAC;AAED,SAAS,iBAAiB,CACxB,iBAAoC,EACpC,iBAAiD;IAEjD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;QACzC,OAAO,CAAC,iBAAiB,CAAC,CAAC;KAC5B;IAED,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAE/B,wDAAwD;IACxD,MAAM,eAAe,GAAG,2BAA2B,CAAC;IACpD,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpE,CAAC;AAED,SAAgB,mBAAmB,CACjC,kBAAuC,EACvC,iBAAiD;IAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACrH,CAAC;AALD,kDAKC;AAED,SAAS,kBAAkB,CACzB,iBAAoC,EACpC,iBAAiD;IAEjD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;QACzC,OAAO,CAAC,iBAAiB,CAAC,CAAC;KAC5B;IAED,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAE/B,uDAAuD;IACvD,MAAM,eAAe,GAAG,gBAAgB,CAAC;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,IAAY;IACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,IAAI,KAAK,CAAC;IACV,MAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,GAAG;QACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,KAAK,EAAE;YACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACrB;KACF,QAAQ,KAAK,EAAE;IAEhB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,wBAAwB,CAAC,OAA0B,EAAE,IAAY,EAAE,MAAsC;IAChH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,OAAO,CAAC,IAAI,CAAC,CAAC;KACf;IAED,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAE/B,yEAAyE;QACzE,2DAA2D;QAC3D,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,aAAa,EAAE;YAClB,SAAS;SACV;QACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;QAEnC,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;KAC5B;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE;QAC3B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;KACpC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/adapters/type-utils.d.ts

@@ -0,0 +1,2 @@
+import { EmptyLine, RenderableContent } from '../templating/types';
+export declare function isEmptyLine(content: RenderableContent): content is EmptyLine;

package/lib/adapters/type-utils.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEmptyLine = void 0;
+function isEmptyLine(content) {
+    return Object.keys(content).includes('type') && content.type === 'empty-line';
+}
+exports.isEmptyLine = isEmptyLine;
+//# sourceMappingURL=type-utils.js.map

package/lib/adapters/type-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../../src/adapters/type-utils.ts"],"names":[],"mappings":";;;AAEA,SAAgB,WAAW,CAAC,OAA0B;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAK,OAA4B,CAAC,IAAI,KAAK,YAAY,CAAC;AACtG,CAAC;AAFD,kCAEC"}

package/lib/application/Apexdocs.d.ts

@@ -1,13 +1,13 @@
-import { ReflectionResult } from '@cparra/apex-reflection';
-import ApexBundle from '../model/apex-bundle';
-/**
- * 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;
-    private static filterByScopes;
-    static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
-}
+import { ReflectionResult } from '@cparra/apex-reflection';
+import ApexBundle from '../model/apex-bundle';
+/**
+ * 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;
+    private static filterByScopes;
+    static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
+}

package/lib/application/Apexdocs.js

@@ -1,77 +1,80 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Apexdocs = void 0;
-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");
-const error_logger_1 = require("../util/error-logger");
-const types_repository_1 = require("../model/types-repository");
-const factory_1 = require("../transpiler/factory");
-/**
- * Application entry-point to generate documentation out of Apex source files.
- */
-class Apexdocs {
-    /**
-     * Generates documentation out of Apex source files.
-     */
-    static generate() {
-        logger_1.Logger.log('Initializing...');
-        const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
-        const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
-        types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
-        const filteredTypes = this.filterByScopes(manifest);
-        types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
-        const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
-        transpiler_1.default.generate(filteredTypes, processor);
-        const generatedFiles = processor.fileBuilder().files();
-        const files = [];
-        file_writer_1.FileWriter.write(generatedFiles, (file) => {
-            logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
-            files.push(file);
-        });
-        settings_1.Settings.getInstance().onAfterProcess(files);
-        // Error logging
-        error_logger_1.default.logErrors(filteredTypes);
-    }
-    static filterByScopes(manifest) {
-        let filteredTypes;
-        let filteredLogMessage;
-        if (settings_1.Settings.getInstance().config.targetGenerator !== 'openapi') {
-            filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
-            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`;
-        }
-        else {
-            // If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
-            // we only keep classes annotated as @RestResource
-            filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
-                'restresource',
-                'httpdelete',
-                'httpget',
-                'httppatch',
-                'httppost',
-                'httpput',
-            ]);
-            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
-        }
-        logger_1.Logger.clear();
-        logger_1.Logger.logSingle(filteredLogMessage, false, 'green', false);
-        logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
-        return filteredTypes;
-    }
-}
-exports.Apexdocs = Apexdocs;
-Apexdocs._reflectionWithLogger = (apexBundle) => {
-    var _a;
-    const result = (0, apex_reflection_1.reflect)(apexBundle.rawTypeContent);
-    if (result.error) {
-        logger_1.Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
-    }
-    return result;
-};
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Apexdocs = void 0;
+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 = __importDefault(require("../transpiler/transpiler"));
+const file_writer_1 = require("../service/file-writer");
+const error_logger_1 = __importDefault(require("../util/error-logger"));
+const types_repository_1 = require("../model/types-repository");
+const factory_1 = require("../transpiler/factory");
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate() {
+        logger_1.Logger.log('Initializing...');
+        const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
+        const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
+        types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
+        const filteredTypes = this.filterByScopes(manifest);
+        types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
+        const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
+        transpiler_1.default.generate(filteredTypes, processor);
+        const generatedFiles = processor.fileBuilder().files();
+        const files = [];
+        file_writer_1.FileWriter.write(generatedFiles, (file) => {
+            logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
+            files.push(file);
+        });
+        settings_1.Settings.getInstance().onAfterProcess(files);
+        // Error logging
+        error_logger_1.default.logErrors(filteredTypes);
+    }
+    static filterByScopes(manifest) {
+        let filteredTypes;
+        let filteredLogMessage;
+        if (settings_1.Settings.getInstance().config.targetGenerator !== 'openapi') {
+            filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
+            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`;
+        }
+        else {
+            // If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
+            // we only keep classes annotated as @RestResource
+            filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
+                'restresource',
+                'httpdelete',
+                'httpget',
+                'httppatch',
+                'httppost',
+                'httpput',
+            ]);
+            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
+        }
+        logger_1.Logger.clear();
+        logger_1.Logger.logSingle(filteredLogMessage, false, 'green', false);
+        logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
+        return filteredTypes;
+    }
+}
+exports.Apexdocs = Apexdocs;
+Apexdocs._reflectionWithLogger = (apexBundle) => {
+    var _a;
+    const result = (0, apex_reflection_1.reflect)(apexBundle.rawTypeContent);
+    if (result.error) {
+        logger_1.Logger.error(`${apexBundle.filePath} - 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

@@ -1 +1 @@
-{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,yDAAkD;AAClD,wDAAoD;AACpD,uDAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/cli/generate.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+#!/usr/bin/env node
+export {};