@cparra/apexdocs 2.25.0-alpha.1 → 2.25.0-alpha.3

package/dist/core/adapters/documentables.js

@@ -0,0 +1,154 @@
+"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, linkGenerator) {
+    function describableToRenderableContent(describable) {
+        if (!describable) {
+            return;
+        }
+        let content = [];
+        for (let i = 0; i < describable.length; i++) {
+            const line = describable[i];
+            // The language might or might not be present after ```
+            const codeBlockMatch = line.match(/^```([a-zA-Z]*)$/);
+            if (codeBlockMatch) {
+                // Check if the language is present, if not, fallback to "apex"
+                const language = codeBlockMatch[1] || 'apex';
+                const codeBlockLines = [];
+                i++;
+                while (i < describable.length) {
+                    const currentLine = describable[i];
+                    if (currentLine.trim() === '```') {
+                        break;
+                    }
+                    codeBlockLines.push(currentLine);
+                    i++;
+                }
+                console.log('codeBlockLines', codeBlockLines);
+                content = [
+                    ...content,
+                    {
+                        __type: 'code-block',
+                        language,
+                        content: codeBlockLines,
+                    },
+                    { __type: 'empty-line' },
+                ];
+                continue;
+            }
+            content = [
+                ...content,
+                ...(0, references_1.replaceInlineReferences)(line, linkGenerator),
+                {
+                    __type: 'empty-line',
+                },
+            ];
+        }
+        return (content
+            .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)));
+        // TODO: Now we want to also extract code blocks if we encounter any line that starts with "```"
+        // return describable.reduce<RenderableContent[]>(
+        //   (acc, line) => {
+        //     if (line.trim() === '') {
+        //       return [...acc, { __type: 'empty-line' }];
+        //     }
+        //
+        //     // The language might or might not be present after ```
+        //     const codeBlockMatch = line.match(/^```([a-zA-Z]*)$/);
+        //     if (codeBlockMatch) {
+        //       console.log('codeBlockMatch', codeBlockMatch);
+        //       // Check if the language is present, if not, fallback to "apex"
+        //       const language = codeBlockMatch[1] || 'apex';
+        //       const codeBlockLines: string[] = [];
+        //       let index = acc.length + 1;
+        //       while (index < describable.length) {
+        //         const currentLine = describable[index];
+        //         if (currentLine.trim() === '```') {
+        //           break;
+        //         }
+        //         codeBlockLines.push(currentLine);
+        //         index++;
+        //       }
+        //       return [
+        //         ...acc,
+        //         {
+        //           __type: 'code-block',
+        //           language,
+        //           content: codeBlockLines,
+        //         },
+        //       ];
+        //     }
+        //
+        //     return [
+        //       ...acc,
+        //       ...replaceInlineReferences(line, linkGenerator),
+        //       {
+        //         __type: 'empty-line',
+        //       },
+        //     ];
+        //   },
+        //   <RenderableContent[]>[],
+        // );
+        // return (
+        //   describable
+        //     .map<RenderableContent[]>((line) => [
+        //       ...replaceInlineReferences(line, linkGenerator),
+        //       {
+        //         __type: 'empty-line',
+        //       },
+        //     ])
+        //     .flatMap((line) => line)
+        //     // If the last element is an empty line, remove it
+        //     .filter((line, index, lines) => !(isEmptyLine(line) && index === lines.length - 1))
+        // );
+    }
+    return {
+        description: describableToRenderableContent(describable),
+    };
+}
+exports.adaptDescribable = adaptDescribable;
+function adaptDocumentable(documentable, linkGenerator, subHeadingLevel) {
+    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, linkGenerator)), { 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;
+    }
+    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 : []);
+    }
+    function bodyLinesToCodeBlock(language, bodyLines) {
+        if (!bodyLines) {
+            return;
+        }
+        return {
+            __type: 'code-block',
+            language,
+            content: bodyLines,
+        };
+    }
+    return Object.assign(Object.assign({}, adaptDescribable((_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines, linkGenerator)), { annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()), customTags: extractCustomTags(documentable), mermaid: {
+            headingLevel: subHeadingLevel,
+            heading: 'Diagram',
+            value: bodyLinesToCodeBlock('mermaid', extractAnnotationBodyLines(documentable, 'mermaid')),
+        }, example: {
+            headingLevel: subHeadingLevel,
+            heading: 'Example',
+            value: bodyLinesToCodeBlock('apex', (_c = (_b = documentable.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) === null || _c === void 0 ? void 0 : _c.bodyLines),
+        }, group: extractAnnotationBody(documentable, 'group'), author: extractAnnotationBody(documentable, 'author'), date: extractAnnotationBody(documentable, 'date'), sees: extractSeeAnnotations(documentable).map(linkGenerator) });
+}
+exports.adaptDocumentable = adaptDocumentable;
+//# sourceMappingURL=documentables.js.map

package/dist/core/adapters/documentables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentables.js","sourceRoot":"","sources":["../../../src/core/adapters/documentables.ts"],"names":[],"mappings":";;;AAEA,6CAAuF;AACvF,6CAA2C;AAE3C,SAAgB,gBAAgB,CAC9B,WAAwB,EACxB,aAA6C;IAI7C,SAAS,8BAA8B,CAAC,WAAwB;QAC9D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,IAAI,OAAO,GAAwB,EAAE,CAAC;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAC5B,uDAAuD;YACvD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACtD,IAAI,cAAc,EAAE,CAAC;gBACnB,+DAA+D;gBAC/D,MAAM,QAAQ,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC;gBAC7C,MAAM,cAAc,GAAa,EAAE,CAAC;gBACpC,CAAC,EAAE,CAAC;gBACJ,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC;oBAC9B,MAAM,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;oBACnC,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC;wBACjC,MAAM;oBACR,CAAC;oBACD,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACjC,CAAC,EAAE,CAAC;gBACN,CAAC;gBACD,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;gBAC9C,OAAO,GAAG;oBACR,GAAG,OAAO;oBACV;wBACE,MAAM,EAAE,YAAY;wBACpB,QAAQ;wBACR,OAAO,EAAE,cAAc;qBACxB;oBACD,EAAE,MAAM,EAAE,YAAY,EAAE;iBACzB,CAAC;gBACF,SAAS;YACX,CAAC;YAED,OAAO,GAAG;gBACR,GAAG,OAAO;gBACV,GAAG,IAAA,oCAAuB,EAAC,IAAI,EAAE,aAAa,CAAC;gBAC/C;oBACE,MAAM,EAAE,YAAY;iBACrB;aACF,CAAC;QACJ,CAAC;QACD,OAAO,CACL,OAAO;aACJ,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;QAEF,gGAAgG;QAEhG,kDAAkD;QAClD,qBAAqB;QACrB,gCAAgC;QAChC,mDAAmD;QACnD,QAAQ;QACR,EAAE;QACF,8DAA8D;QAC9D,6DAA6D;QAC7D,4BAA4B;QAC5B,uDAAuD;QACvD,wEAAwE;QACxE,sDAAsD;QACtD,6CAA6C;QAC7C,oCAAoC;QACpC,6CAA6C;QAC7C,kDAAkD;QAClD,8CAA8C;QAC9C,mBAAmB;QACnB,YAAY;QACZ,4CAA4C;QAC5C,mBAAmB;QACnB,UAAU;QACV,iBAAiB;QACjB,kBAAkB;QAClB,YAAY;QACZ,kCAAkC;QAClC,sBAAsB;QACtB,qCAAqC;QACrC,aAAa;QACb,WAAW;QACX,QAAQ;QACR,EAAE;QACF,eAAe;QACf,gBAAgB;QAChB,yDAAyD;QACzD,UAAU;QACV,gCAAgC;QAChC,WAAW;QACX,SAAS;QACT,OAAO;QACP,6BAA6B;QAC7B,KAAK;QAEL,WAAW;QACX,gBAAgB;QAChB,4CAA4C;QAC5C,yDAAyD;QACzD,UAAU;QACV,gCAAgC;QAChC,WAAW;QACX,SAAS;QACT,+BAA+B;QAC/B,yDAAyD;QACzD,0FAA0F;QAC1F,KAAK;IACP,CAAC;IAED,OAAO;QACL,WAAW,EAAE,8BAA8B,CAAC,WAAW,CAAC;KACzD,CAAC;AACJ,CAAC;AAvHD,4CAuHC;AAED,SAAgB,iBAAiB,CAC/B,YAA0B,EAC1B,aAA6C,EAC7C,eAAuB;;IAEvB,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,EAAE,aAAa,CAAC,KAC/D,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,SAAS,qBAAqB,CAAC,IAAkB,EAAE,cAAsB;;QACvE,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,IAAkB;;QAC/C,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,SAAS,oBAAoB,CAAC,QAAgB,EAAE,SAA+B;QAC7E,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QACD,OAAO;YACL,MAAM,EAAE,YAAY;YACpB,QAAQ;YACR,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,uCACK,gBAAgB,CAAC,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,EAAE,aAAa,CAAC,KAC7E,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;YACP,YAAY,EAAE,eAAe;YAC7B,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,oBAAoB,CAAC,SAAS,EAAE,0BAA0B,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;SAC5F,EACD,OAAO,EAAE;YACP,YAAY,EAAE,eAAe;YAC7B,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,oBAAoB,CAAC,MAAM,EAAE,MAAA,MAAA,YAAY,CAAC,UAAU,0CAAE,iBAAiB,0CAAE,SAAS,CAAC;SAC3F,EACD,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,EACnD,MAAM,EAAE,qBAAqB,CAAC,YAAY,EAAE,QAAQ,CAAC,EACrD,IAAI,EAAE,qBAAqB,CAAC,YAAY,EAAE,MAAM,CAAC,EACjD,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,IAC5D;AACJ,CAAC;AApED,8CAoEC"}

package/{lib → dist/core}/adapters/fields-and-properties.d.ts

@@ -1,4 +1,3 @@
-import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../model/inheritance';
-import { RenderableField } from '../core/renderable/types';
+import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance, RenderableField } from './types';
 import { GetRenderableContentByTypeName } from './references';
 export declare function adaptFieldOrProperty(field: FieldMirrorWithInheritance | PropertyMirrorWithInheritance, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableField;

package/{lib → dist/core}/adapters/fields-and-properties.js

@@ -1,15 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adaptFieldOrProperty = adaptFieldOrProperty;
+exports.adaptFieldOrProperty = void 0;
 const documentables_1 = require("./documentables");
-const references_1 = require("./references");
 function adaptFieldOrProperty(field, linkGenerator, baseHeadingLevel) {
     function buildSignature() {
         const { access_modifier, name } = field;
         const memberModifiers = field.memberModifiers.join(' ');
-        return (`${access_modifier} ${memberModifiers} ${name}`
+        const codeContents = `${access_modifier} ${memberModifiers} ${name}`
             // remove double spaces
-            .replace(/ {2}/g, ' '));
+            .replace(/ {2}/g, ' ');
+        return {
+            __type: 'code-block',
+            language: 'apex',
+            content: [codeContents],
+        };
     }
     return {
         headingLevel: baseHeadingLevel,
@@ -18,15 +22,16 @@ function adaptFieldOrProperty(field, linkGenerator, baseHeadingLevel) {
         type: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Type',
-            value: (0, references_1.linkFromTypeNameGenerator)(field.typeReference.rawDeclaration),
+            value: linkGenerator(field.typeReference.rawDeclaration),
         },
         inherited: field.inherited,
         accessModifier: field.access_modifier,
         signature: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Signature',
-            value: [buildSignature()],
+            value: buildSignature(),
         },
     };
 }
+exports.adaptFieldOrProperty = adaptFieldOrProperty;
 //# sourceMappingURL=fields-and-properties.js.map

package/dist/core/adapters/fields-and-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields-and-properties.js","sourceRoot":"","sources":["../../../src/core/adapters/fields-and-properties.ts"],"names":[],"mappings":";;;AACA,mDAAoD;AAGpD,SAAgB,oBAAoB,CAClC,KAAiE,EACjE,aAA6C,EAC7C,gBAAwB;IAExB,SAAS,cAAc;QACrB,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QACxC,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,YAAY,GAAG,GAAG,eAAe,IAAI,eAAe,IAAI,IAAI,EAAE;YAClE,uBAAuB;aACtB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACzB,OAAO;YACL,MAAM,EAAE,YAAY;YACpB,QAAQ,EAAE,MAAM;YAChB,OAAO,EAAE,CAAC,YAAY,CAAC;SACxB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,GAAG,EAAE,IAAA,iCAAiB,EAAC,KAAK,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QAClE,OAAO,EAAE,KAAK,CAAC,IAAI;QACnB,IAAI,EAAE;YACJ,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC;SACzD;QACD,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,cAAc,EAAE,KAAK,CAAC,eAAe;QACrC,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,cAAc,EAAE;SACxB;KACF,CAAC;AACJ,CAAC;AAnCD,oDAmCC"}

package/{lib → dist/core}/adapters/methods-and-constructors.d.ts

@@ -1,5 +1,5 @@
 import { ConstructorMirror, MethodMirror } from '@cparra/apex-reflection';
-import { RenderableConstructor, RenderableMethod } from '../core/renderable/types';
+import { RenderableConstructor, RenderableMethod } from './types';
 import { GetRenderableContentByTypeName } from './references';
 export declare function adaptMethod(method: MethodMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableMethod;
 export declare function adaptConstructor(typeName: string, constructor: ConstructorMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableConstructor;

package/{lib → dist/core}/adapters/methods-and-constructors.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adaptMethod = adaptMethod;
-exports.adaptConstructor = adaptConstructor;
+exports.adaptConstructor = exports.adaptMethod = void 0;
 const documentables_1 = require("./documentables");
-const references_1 = require("./references");
 function adaptMethod(method, linkGenerator, baseHeadingLevel) {
     var _a, _b, _c;
     function buildTitle(method) {
@@ -17,7 +15,11 @@ function adaptMethod(method, linkGenerator, baseHeadingLevel) {
             .map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
             .join(', ');
         const members = memberModifiers.length > 0 ? `${memberModifiers.join(' ')} ` : '';
-        return `${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`;
+        return {
+            __type: 'code-block',
+            language: 'apex',
+            content: [`${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`],
+        };
     }
     return {
         headingLevel: baseHeadingLevel,
@@ -26,26 +28,27 @@ function adaptMethod(method, linkGenerator, baseHeadingLevel) {
         signature: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Signature',
-            value: [buildSignature(method)],
+            value: buildSignature(method),
         },
         returnType: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Return Type',
-            value: 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, linkGenerator)), { type: (0, references_1.linkFromTypeNameGenerator)(method.typeReference.rawDeclaration) }),
+            value: 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, linkGenerator)), { type: linkGenerator(method.typeReference.rawDeclaration) }),
         },
         throws: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Throws',
-            value: (_c = method.docComment) === null || _c === void 0 ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown)),
+            value: (_c = method.docComment) === null || _c === void 0 ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator)),
         },
         parameters: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Parameters',
-            value: method.parameters.map((param) => mapParameters(method, param)),
+            value: method.parameters.map((param) => mapParameters(method, param, linkGenerator)),
         },
         inherited: method.inherited,
     };
 }
+exports.adaptMethod = adaptMethod;
 function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel) {
     var _a;
     function buildTitle(name, constructor) {
@@ -58,7 +61,11 @@ function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel
         const parameters = constructor.parameters
             .map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
             .join(', ');
-        return `${access_modifier} ${name}(${parameters})`;
+        return {
+            __type: 'code-block',
+            language: 'apex',
+            content: [`${access_modifier} ${name}(${parameters})`],
+        };
     }
     return {
         doc: (0, documentables_1.adaptDocumentable)(constructor, linkGenerator, baseHeadingLevel + 1),
@@ -67,26 +74,27 @@ function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel
         signature: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Signature',
-            value: [buildSignature(typeName, constructor)],
+            value: buildSignature(typeName, constructor),
         },
         parameters: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Parameters',
-            value: constructor.parameters.map((param) => mapParameters(constructor, param)),
+            value: constructor.parameters.map((param) => mapParameters(constructor, param, linkGenerator)),
         },
         throws: {
             headingLevel: baseHeadingLevel + 1,
             heading: 'Throws',
-            value: (_a = constructor.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown)),
+            value: (_a = constructor.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator)),
         },
     };
 }
-function mapParameters(documentable, param) {
+exports.adaptConstructor = adaptConstructor;
+function mapParameters(documentable, param, linkGenerator) {
     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, references_1.linkFromTypeNameGenerator)), { name: param.name, type: (0, references_1.linkFromTypeNameGenerator)(param.typeReference.rawDeclaration) });
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(paramAnnotation === null || paramAnnotation === void 0 ? void 0 : paramAnnotation.bodyLines, linkGenerator)), { name: param.name, type: linkGenerator(param.typeReference.rawDeclaration) });
 }
-function mapThrows(thrown) {
-    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(thrown.bodyLines, references_1.linkFromTypeNameGenerator)), { type: (0, references_1.linkFromTypeNameGenerator)(thrown.exceptionName) });
+function mapThrows(thrown, linkGenerator) {
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(thrown.bodyLines, linkGenerator)), { type: linkGenerator(thrown.exceptionName) });
 }
 //# sourceMappingURL=methods-and-constructors.js.map

package/dist/core/adapters/methods-and-constructors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods-and-constructors.js","sourceRoot":"","sources":["../../../src/core/adapters/methods-and-constructors.ts"],"names":[],"mappings":";;;AAEA,mDAAsE;AAItE,SAAgB,WAAW,CACzB,MAAoB,EACpB,aAA6C,EAC7C,gBAAwB;;IAExB,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;YACL,MAAM,EAAE,YAAY;YACpB,QAAQ,EAAE,MAAM;YAChB,OAAO,EAAE,CAAC,GAAG,eAAe,IAAI,OAAO,GAAG,aAAa,CAAC,cAAc,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;SACjG,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,GAAG,EAAE,IAAA,iCAAiB,EAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACnE,OAAO,EAAE,UAAU,CAAC,MAAqC,CAAC;QAC1D,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,cAAc,CAAC,MAAqC,CAAC;SAC7D;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,aAAa;YACtB,KAAK,kCACA,IAAA,gCAAgB,EAAC,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,gBAAgB,0CAAE,SAAS,EAAE,aAAa,CAAC,KAClF,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,GACzD;SACF;QACD,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SAC9F;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;SACrF;QACD,SAAS,EAAG,MAAsC,CAAC,SAAS;KAC7D,CAAC;AACJ,CAAC;AArDD,kCAqDC;AAED,SAAgB,gBAAgB,CAC9B,QAAgB,EAChB,WAA8B,EAC9B,aAA6C,EAC7C,gBAAwB;;IAExB,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;YACL,MAAM,EAAE,YAAY;YACpB,QAAQ,EAAE,MAAM;YAChB,OAAO,EAAE,CAAC,GAAG,eAAe,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;SACvD,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,EAAE,IAAA,iCAAiB,EAAC,WAAW,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACxE,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC;QAC1C,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC;SAC7C;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;SAC/F;QACD,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,MAAA,WAAW,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SACnG;KACF,CAAC;AACJ,CAAC;AA5CD,4CA4CC;AAED,SAAS,aAAa,CACpB,YAA0B,EAC1B,KAAsB,EACtB,aAA6C;;IAE7C,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,EAAE,aAAa,CAAC,KAC9D,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,IACvD;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,MAAwB,EAAE,aAA6C;IACxF,uCACK,IAAA,gCAAgB,EAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,KACpD,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,IACzC;AACJ,CAAC"}

package/{lib → dist/core}/adapters/references.d.ts

@@ -1,5 +1,4 @@
-import { RenderableContent, StringOrLink } from '../core/renderable/types';
+import { RenderableContent, StringOrLink } from './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 replaceInlineReferences(text: string, linkReplacer: GetRenderableContentByTypeName, emailReplacer?: GetRenderableContentByTypeName): RenderableContent[];
 export declare function replaceInlineEmails(renderableContents: RenderableContent[], getLinkByTypeName: GetRenderableContentByTypeName): RenderableContent[];

package/{lib → dist/core}/adapters/references.js

@@ -1,22 +1,17 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.linkFromTypeNameGenerator = void 0;
-exports.replaceInlineReferences = replaceInlineReferences;
-exports.replaceInlineEmails = replaceInlineEmails;
-const class_file_generatorHelper_1 = __importDefault(require("../transpiler/markdown/class-file-generatorHelper"));
-exports.linkFromTypeNameGenerator = class_file_generatorHelper_1.default.getRenderableLinkByTypeName;
+exports.replaceInlineEmails = exports.replaceInlineReferences = void 0;
 function defaultGetEmailByReference(email) {
     return {
+        __type: 'link',
         title: email,
         url: `mailto:${email}`,
     };
 }
-function replaceInlineReferences(text, linkReplacer = exports.linkFromTypeNameGenerator, emailReplacer = defaultGetEmailByReference) {
+function replaceInlineReferences(text, linkReplacer, emailReplacer = defaultGetEmailByReference) {
     return replaceInlineEmails(replaceInlineLinks([text], linkReplacer), emailReplacer);
 }
+exports.replaceInlineReferences = replaceInlineReferences;
 function replaceInlineLinks(renderableContents, getLinkByTypeName) {
     return renderableContents.flatMap((renderableContent) => inlineLinkContent(renderableContent, getLinkByTypeName));
 }
@@ -33,6 +28,7 @@ function inlineLinkContent(renderableContent, 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];

package/dist/core/adapters/references.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"references.js","sourceRoot":"","sources":["../../../src/core/adapters/references.ts"],"names":[],"mappings":";;;AAIA,SAAS,0BAA0B,CAAC,KAAa;IAC/C,OAAO;QACL,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,UAAU,KAAK,EAAE;KACvB,CAAC;AACJ,CAAC;AAED,SAAgB,uBAAuB,CACrC,IAAY,EACZ,YAA4C,EAC5C,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,CAAC;QAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;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,CAAC;QAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;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,CAAC;QACF,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,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,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,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,CAAC;YACnB,SAAS;QACX,CAAC;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;IAC7B,CAAC;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/core/adapters/type-utils.d.ts

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

package/dist/core/adapters/type-utils.js

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

package/dist/core/adapters/type-utils.js.map

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

package/dist/core/apex-bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apex-bundle.js","sourceRoot":"","sources":["../../src/core/apex-bundle.ts"],"names":[],"mappings":";;AAAA,MAAqB,UAAU;IAC7B,YAAmB,QAAgB,EAAS,cAAsB,EAAS,kBAAiC;QAAzF,aAAQ,GAAR,QAAQ,CAAQ;QAAS,mBAAc,GAAd,cAAc,CAAQ;QAAS,uBAAkB,GAAlB,kBAAkB,CAAe;IAAG,CAAC;CACjH;AAFD,6BAEC"}

package/{lib → dist}/core/generate-docs.d.ts

@@ -1,6 +1,5 @@
-import { Type } from '@cparra/apex-reflection';
 import * as E from 'fp-ts/Either';
-export declare const documentType: (type: Type, linkGenerator: import("../adapters/references").GetRenderableContentByTypeName, namespace?: string | undefined) => string;
+import ApexBundle from './apex-bundle';
 export type DocumentationBundle = {
     format: 'markdown';
     referenceGuide: string;
@@ -15,9 +14,15 @@ type DocumentationConfig = {
     referenceGuideTemplate: string;
 };
 type DocOutput = {
+    directory: string;
     docContents: string;
     typeName: string;
     type: 'class' | 'interface' | 'enum';
 };
-export declare function generateDocs(input: string[], config?: Partial<DocumentationConfig>): E.Either<string[], DocumentationBundle>;
+export declare function generateDocs(input: ApexBundle[], config?: Partial<DocumentationConfig>): E.Either<ReflectionError[], DocumentationBundle>;
+export declare class ReflectionError {
+    file: string;
+    message: string;
+    constructor(file: string, message: string);
+}
 export {};

package/{lib → dist}/core/generate-docs.js

@@ -26,20 +26,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.documentType = void 0;
-exports.generateDocs = generateDocs;
+exports.ReflectionError = exports.generateDocs = void 0;
 const apex_reflection_1 = require("@cparra/apex-reflection");
-const apex_types_1 = require("../adapters/apex-types");
-const class_template_1 = require("../transpiler/markdown/plain-markdown/class-template");
-const enum_template_1 = require("../transpiler/markdown/plain-markdown/enum-template");
-const interface_template_1 = require("../transpiler/markdown/plain-markdown/interface-template");
-const E = __importStar(require("fp-ts/Either"));
+const O = __importStar(require("fp-ts/Option"));
 const function_1 = require("fp-ts/function");
+const E = __importStar(require("fp-ts/Either"));
+const apex_types_1 = require("./adapters/apex-types");
 const template_1 = require("./template");
-const manifest_1 = __importDefault(require("../model/manifest"));
 const reference_guide_1 = require("./templates/reference-guide");
-const documentables_1 = require("../adapters/documentables");
-exports.documentType = (0, function_1.flow)(apex_types_1.typeToRenderableType, resolveApexTypeTemplate, compile);
+const documentables_1 = require("./adapters/documentables");
+const inheritance_chain_1 = require("./inheritance-chain");
+const manifest_1 = __importDefault(require("./manifest"));
+// TODO: The core should never depend on things from the outside, so it should never reference "back" (../)
+const class_template_1 = require("../transpiler/markdown/plain-markdown/class-template");
+const interface_template_1 = require("../transpiler/markdown/plain-markdown/interface-template");
+const enum_template_1 = require("../transpiler/markdown/plain-markdown/enum-template");
+const metadata_processor_1 = __importDefault(require("../service/metadata-processor"));
 const configDefaults = {
     scope: ['public'],
     outputDir: 'docs',
@@ -48,25 +50,25 @@ const configDefaults = {
 };
 function generateDocs(input, config) {
     const configWithDefaults = Object.assign(Object.assign({}, configDefaults), config);
-    return (0, function_1.pipe)(input, (input) => input.map(reflectSourceBody), checkForReflectionErrors, E.map((types) => types.map((type) => addInheritedMembers(type, types))), E.map((types) => filterTypesOutOfScope(types, configWithDefaults.scope)), E.map((types) => typesToRenderableBundle(types, configWithDefaults)), E.map(({ references, renderables }) => ({
+    return (0, function_1.pipe)(input, (input) => input.map((bundle) => reflectSourceBody(bundle)), checkForReflectionErrors, E.map((types) => filterTypesOutOfScope(types, configWithDefaults.scope)), E.map((types) => types.map((type) => addInheritedMembers(type, types))), E.map((types) => types.map((type) => addInheritanceChain(type, types))), E.map((types) => typesToRenderableBundle(types, configWithDefaults)), E.map(({ references, renderables }) => ({
         referenceGuide: (0, function_1.pipe)(referencesToReferenceGuide(references, configWithDefaults.referenceGuideTemplate)),
-        docs: renderables.map(renderableToOutputDoc),
+        docs: renderables.map((renderable) => renderableToOutputDoc(Object.values(references).flat(), renderable)),
     })), E.map(({ referenceGuide, docs }) => ({ format: 'markdown', referenceGuide: referenceGuide, docs })));
 }
+exports.generateDocs = generateDocs;
 function typesToRenderableBundle(types, config) {
     return types.reduce((acc, type) => {
         var _a;
-        const renderable = (0, apex_types_1.typeToRenderableType)(type, (referenceName) => {
+        const renderable = (0, apex_types_1.typeToRenderable)(type, (referenceName) => {
             return linkFromTypeNameGenerator(type, types, referenceName, config);
         }, config.namespace);
         acc.renderables.push(renderable);
         const descriptionLines = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines;
         const reference = {
+            typeName: type.name,
+            directory: getDirectoryFromRoot(config, type),
             title: getLinkFromRoot(config, type),
-            description: (0, documentables_1.adaptDescribable)(descriptionLines, (referenceName) => {
-                const type = findType(types, referenceName);
-                return type ? getLinkFromRoot(config, type) : referenceName;
-            }).description,
+            description: (0, documentables_1.adaptDescribable)(descriptionLines, (referenceName) => getPossibleLinkFromRoot(config, referenceName, findType(types, referenceName))).description,
         };
         const group = getTypeGroup(type, config);
         if (!acc.references[group]) {
@@ -79,9 +81,11 @@ function typesToRenderableBundle(types, config) {
         renderables: [],
     });
 }
-function renderableToOutputDoc(renderable) {
+function renderableToOutputDoc(referenceGuideReference, renderable) {
     function buildDocOutput(renderable, docContents) {
+        const reference = referenceGuideReference.find((ref) => ref.typeName.toLowerCase() === renderable.name.toLowerCase());
         return {
+            directory: reference.directory,
             docContents,
             typeName: renderable.name,
             type: renderable.type,
@@ -118,10 +122,34 @@ function checkForReflectionErrors(reflectionResult) {
     }
     return (0, function_1.pipe)(reflectionResult, reduceReflectionResultIntoSingleEither, ({ errors, types }) => errors.length ? E.left(errors) : E.right(types));
 }
-function reflectSourceBody(input) {
+function addFileMetadataToTypeAnnotation(type, metadata) {
+    return (0, function_1.pipe)(O.fromNullable(metadata), O.map((metadata) => {
+        const metadataParams = metadata_processor_1.default.process(metadata);
+        metadataParams.forEach((value, key) => {
+            const declaration = `${key}: ${value}`;
+            type.annotations.push({
+                rawDeclaration: declaration,
+                name: declaration,
+                type: declaration,
+            });
+        });
+        return type;
+    }), O.getOrElse(() => type));
+}
+class ReflectionError {
+    constructor(file, message) {
+        this.file = file;
+        this.message = message;
+    }
+}
+exports.ReflectionError = ReflectionError;
+function reflectSourceBody(apexBundle) {
+    const { filePath, rawTypeContent: input, rawMetadataContent: metadata } = apexBundle;
     const result = (0, apex_reflection_1.reflect)(input);
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    return result.error ? E.left(result.error.message) : E.right(result.typeMirror);
+    return result.error
+        ? E.left(new ReflectionError(filePath, result.error.message))
+        : E.right(addFileMetadataToTypeAnnotation(result.typeMirror, metadata));
 }
 function resolveApexTypeTemplate(renderable) {
     function getTemplate(renderable) {
@@ -156,6 +184,15 @@ function addInheritedMembers(current, repository) {
         return addInheritedClassMembers(current, repository);
     }
 }
+function addInheritanceChain(current, repository) {
+    if (current.type_name === 'enum' || current.type_name === 'interface') {
+        return current;
+    }
+    else {
+        const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, current);
+        return Object.assign(Object.assign({}, current), { inheritanceChain });
+    }
+}
 function getParents(extendedNamesExtractor, current, repository) {
     return (0, function_1.pipe)(extendedNamesExtractor(current), (interfaces) => interfaces.map((interfaceName) => repository.find((type) => type.name === interfaceName)), (interfaces = []) => interfaces.filter((type) => type !== undefined), (interfaces) => interfaces.reduce((acc, current) => [...acc, ...getParents(extendedNamesExtractor, current, repository)], interfaces));
 }
@@ -198,6 +235,7 @@ function linkFromTypeNameGenerator(typeBeingDocumented, repository, referenceNam
     }
     const [fullClassName, fileLink] = getFileLinkTuple(typeBeingDocumented, type, config);
     return {
+        __type: 'link',
         title: fullClassName,
         url: fileLink,
     };
@@ -210,14 +248,31 @@ function getFileLinkTuple(typeBeingDocumented, referencedType, config) {
     const fullClassName = `${namespacePrefix}${referencedType.name}`;
     return [fullClassName, `${directoryRoot}${fullClassName}.md`];
 }
-function getLinkFromRoot(config, type) {
+function getDirectoryFromRoot(config, type) {
     if (!type) {
         return '';
     }
-    const namespacePrefix = config.namespace ? `${config.namespace}./` : '';
+    return `./${getSanitizedGroup(type, config)}`;
+}
+function getPossibleLinkFromRoot(config, fallback, type) {
+    if (!type) {
+        return fallback;
+    }
+    const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
+    const title = `${namespacePrefix}${type.name}`;
+    return {
+        __type: 'link',
+        title: title,
+        url: `${getDirectoryFromRoot(config, type)}/${title}.md`,
+    };
+}
+function getLinkFromRoot(config, type) {
+    const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
+    const title = `${namespacePrefix}${type.name}`;
     return {
-        title: `${namespacePrefix}${type.name}`,
-        url: `./${namespacePrefix}${getSanitizedGroup(type, config)}/${type.name}.md`,
+        __type: 'link',
+        title: title,
+        url: `${getDirectoryFromRoot(config, type)}/${title}.md`,
     };
 }
 function getDirectoryRoot(typeBeingDocumented, referencedType, config) {