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

package/lib/cli/generate.js

@@ -1,157 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const yargs = __importStar(require("yargs"));
-const settings_1 = require("../settings");
-const Apexdocs_1 = require("../application/Apexdocs");
-const cosmiconfig_1 = require("cosmiconfig");
-const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
-result.then((config) => {
-    var _a, _b, _c;
-    yargs.config(config === null || config === void 0 ? void 0 : config.config);
-    let argv = yargs
-        .options({
-        sourceDir: {
-            type: 'string',
-            alias: 's',
-            demandOption: true,
-            describe: 'The directory location which contains your apex .cls classes.',
-        },
-        targetDir: {
-            type: 'string',
-            alias: 't',
-            default: './docs/',
-            describe: 'The directory location where documentation will be generated to.',
-        },
-        recursive: {
-            type: 'boolean',
-            alias: 'r',
-            default: true,
-            describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
-        },
-        scope: {
-            type: 'string',
-            array: true,
-            alias: 'p',
-            default: ['global'],
-            describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
-                'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
-                'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
-        },
-        targetGenerator: {
-            type: 'string',
-            alias: 'g',
-            default: 'jekyll',
-            choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
-            describe: 'Define the static file generator for which the documents will be created. ' +
-                'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
-        },
-        indexOnly: {
-            type: 'boolean',
-            default: false,
-            describe: 'Defines whether only the index file should be generated.',
-        },
-        defaultGroupName: {
-            type: 'string',
-            default: 'Miscellaneous',
-            describe: 'Defines the @group name to be used when a file does not specify it.',
-        },
-        sanitizeHtml: {
-            type: 'boolean',
-            default: true,
-            describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
-                'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
-                'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
-                'Content in @example blocks are never sanitized.',
-        },
-        openApiTitle: {
-            type: 'string',
-            default: 'Apex REST Api',
-            describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
-        },
-        title: {
-            type: 'string',
-            describe: "If this allows you to specify the title of the generated documentation's home file.",
-            default: 'Classes',
-        },
-        namespace: {
-            type: 'string',
-            describe: 'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
-                "If generating an OpenApi definition, it will be added to the file's Server Url.",
-        },
-        openApiFileName: {
-            type: 'string',
-            describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
-            default: 'openapi',
-        },
-        sortMembersAlphabetically: {
-            type: 'boolean',
-            describe: 'Whether to sort members alphabetically.',
-            default: false,
-        },
-        includeMetadata: {
-            type: 'boolean',
-            describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
-            default: false,
-        },
-        documentationRootDir: {
-            type: 'string',
-            describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
-        },
-    })
-        .parseSync();
-    if (config) {
-        argv = Object.assign(Object.assign({}, config.config), argv);
-    }
-    settings_1.Settings.build({
-        sourceDirectory: argv.sourceDir,
-        recursive: argv.recursive,
-        scope: argv.scope,
-        outputDir: argv.targetDir,
-        targetGenerator: argv.targetGenerator,
-        indexOnly: argv.indexOnly,
-        defaultGroupName: argv.defaultGroupName,
-        sanitizeHtml: argv.sanitizeHtml,
-        openApiTitle: argv.openApiTitle,
-        title: argv.title,
-        namespace: argv.namespace,
-        openApiFileName: argv.openApiFileName,
-        sortMembersAlphabetically: argv.sortMembersAlphabetically,
-        includeMetadata: argv.includeMetadata,
-        rootDir: argv.documentationRootDir,
-        onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
-        onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
-        frontMatterHeader: (_c = config === null || config === void 0 ? void 0 : config.config) === null || _c === void 0 ? void 0 : _c.frontMatterHeader,
-    });
-    try {
-        Apexdocs_1.Apexdocs.generate();
-    }
-    catch (error) {
-        console.error(error);
-        process.exit(1);
-    }
-});
-//# sourceMappingURL=generate.js.map

package/lib/cli/generate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK;SACb,OAAO,CAAC;QACP,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC;SACD,SAAS,EAAE,CAAC;IAEf,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;IACvC,CAAC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;QACzD,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;KACrD,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,mBAAQ,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC"}

package/lib/core/generate-docs.d.ts

@@ -1,23 +0,0 @@
-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;
-export type DocumentationBundle = {
-    format: 'markdown';
-    referenceGuide: string;
-    docs: DocOutput[];
-};
-type DocumentationConfig = {
-    scope: string[];
-    outputDir: string;
-    namespace?: string;
-    sortMembersAlphabetically?: boolean;
-    defaultGroupName: string;
-    referenceGuideTemplate: string;
-};
-type DocOutput = {
-    docContents: string;
-    typeName: string;
-    type: 'class' | 'interface' | 'enum';
-};
-export declare function generateDocs(input: string[], config?: Partial<DocumentationConfig>): E.Either<string[], DocumentationBundle>;
-export {};

package/lib/core/generate-docs.js

@@ -1,241 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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;
-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 function_1 = require("fp-ts/function");
-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 configDefaults = {
-    scope: ['public'],
-    outputDir: 'docs',
-    defaultGroupName: 'Miscellaneous',
-    referenceGuideTemplate: reference_guide_1.referenceGuideTemplate,
-};
-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 }) => ({
-        referenceGuide: (0, function_1.pipe)(referencesToReferenceGuide(references, configWithDefaults.referenceGuideTemplate)),
-        docs: renderables.map(renderableToOutputDoc),
-    })), E.map(({ referenceGuide, docs }) => ({ format: 'markdown', referenceGuide: referenceGuide, docs })));
-}
-function typesToRenderableBundle(types, config) {
-    return types.reduce((acc, type) => {
-        var _a;
-        const renderable = (0, apex_types_1.typeToRenderableType)(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 = {
-            title: getLinkFromRoot(config, type),
-            description: (0, documentables_1.adaptDescribable)(descriptionLines, (referenceName) => {
-                const type = findType(types, referenceName);
-                return type ? getLinkFromRoot(config, type) : referenceName;
-            }).description,
-        };
-        const group = getTypeGroup(type, config);
-        if (!acc.references[group]) {
-            acc.references[group] = [];
-        }
-        acc.references[group].push(reference);
-        return acc;
-    }, {
-        references: {},
-        renderables: [],
-    });
-}
-function renderableToOutputDoc(renderable) {
-    function buildDocOutput(renderable, docContents) {
-        return {
-            docContents,
-            typeName: renderable.name,
-            type: renderable.type,
-        };
-    }
-    return (0, function_1.pipe)(renderable, resolveApexTypeTemplate, compile, (docContents) => buildDocOutput(renderable, docContents));
-}
-function referencesToReferenceGuide(references, template) {
-    function alphabetizeReferences(references) {
-        return Object.keys(references)
-            .sort((a, b) => a.localeCompare(b))
-            .reduce((acc, key) => {
-            acc[key] = references[key].sort((a, b) => a.title.toString().localeCompare(b.title.toString()));
-            return acc;
-        }, {});
-    }
-    return (0, function_1.pipe)(references, alphabetizeReferences, (references) => compile({
-        template: template,
-        source: references,
-    }));
-}
-function filterTypesOutOfScope(types, scope) {
-    return new manifest_1.default(types).filteredByAccessModifierAndAnnotations(scope);
-}
-function checkForReflectionErrors(reflectionResult) {
-    function reduceReflectionResultIntoSingleEither(results) {
-        return results.reduce((acc, result) => {
-            E.isLeft(result) ? acc.errors.push(result.left) : acc.types.push(result.right);
-            return acc;
-        }, {
-            errors: [],
-            types: [],
-        });
-    }
-    return (0, function_1.pipe)(reflectionResult, reduceReflectionResultIntoSingleEither, ({ errors, types }) => errors.length ? E.left(errors) : E.right(types));
-}
-function reflectSourceBody(input) {
-    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);
-}
-function resolveApexTypeTemplate(renderable) {
-    function getTemplate(renderable) {
-        switch (renderable.type) {
-            case 'enum':
-                return enum_template_1.enumMarkdownTemplate;
-            case 'interface':
-                return interface_template_1.interfaceMarkdownTemplate;
-            case 'class':
-                return class_template_1.classMarkdownTemplate;
-        }
-    }
-    return {
-        template: getTemplate(renderable),
-        source: renderable,
-    };
-}
-function compile(request) {
-    return template_1.Template.getInstance().compile(request);
-}
-function findType(repository, referenceName) {
-    return repository.find((currentType) => currentType.name.toLowerCase() === referenceName.toLowerCase());
-}
-function addInheritedMembers(current, repository) {
-    if (current.type_name === 'enum') {
-        return current;
-    }
-    else if (current.type_name === 'interface') {
-        return addInheritedInterfaceMethods(current, repository);
-    }
-    else {
-        return addInheritedClassMembers(current, repository);
-    }
-}
-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));
-}
-function addInheritedInterfaceMethods(interfaceMirror, repository) {
-    function methodAlreadyExists(memberName, members) {
-        return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
-    }
-    function parentExtractor(interfaceMirror) {
-        return interfaceMirror.extended_interfaces;
-    }
-    const parents = getParents(parentExtractor, interfaceMirror, repository);
-    return Object.assign(Object.assign({}, interfaceMirror), { methods: parents.reduce((acc, currentValue) => [
-            ...acc,
-            ...currentValue.methods
-                .filter((method) => !methodAlreadyExists(method.name, acc))
-                .map((method) => (Object.assign(Object.assign({}, method), { inherited: true }))),
-        ], interfaceMirror.methods) });
-}
-function addInheritedClassMembers(classMirror, repository) {
-    function memberAlreadyExists(memberName, members) {
-        return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
-    }
-    function parentExtractor(classMirror) {
-        return classMirror.extended_class ? [classMirror.extended_class] : [];
-    }
-    function filterMember(members, existing) {
-        return members
-            .filter((member) => member.access_modifier.toLowerCase() !== 'private')
-            .filter((member) => !memberAlreadyExists(member.name, existing))
-            .map((member) => (Object.assign(Object.assign({}, member), { inherited: true })));
-    }
-    const parents = getParents(parentExtractor, classMirror, repository);
-    return Object.assign(Object.assign({}, classMirror), { fields: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.fields, acc)], classMirror.fields), properties: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.properties, acc)], classMirror.properties), methods: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.methods, acc)], classMirror.methods) });
-}
-function linkFromTypeNameGenerator(typeBeingDocumented, repository, referenceName, config) {
-    const type = findType(repository, referenceName);
-    if (!type) {
-        // If the type is not found, we return the type name as a string.
-        return referenceName;
-    }
-    const [fullClassName, fileLink] = getFileLinkTuple(typeBeingDocumented, type, config);
-    return {
-        title: fullClassName,
-        url: fileLink,
-    };
-}
-function getFileLinkTuple(typeBeingDocumented, referencedType, config) {
-    const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
-    const directoryRoot = `${getDirectoryRoot(typeBeingDocumented, referencedType, config)}`;
-    // TODO: Instead of adding a "." to the name when there is a namespace, maybe we want to create a folder for everything
-    // within that namespace and put the files in there.
-    const fullClassName = `${namespacePrefix}${referencedType.name}`;
-    return [fullClassName, `${directoryRoot}${fullClassName}.md`];
-}
-function getLinkFromRoot(config, type) {
-    if (!type) {
-        return '';
-    }
-    const namespacePrefix = config.namespace ? `${config.namespace}./` : '';
-    return {
-        title: `${namespacePrefix}${type.name}`,
-        url: `./${namespacePrefix}${getSanitizedGroup(type, config)}/${type.name}.md`,
-    };
-}
-function getDirectoryRoot(typeBeingDocumented, referencedType, config) {
-    if (getTypeGroup(typeBeingDocumented, config) === getTypeGroup(referencedType, config)) {
-        // If the types the same groups then we simply link directly to that file
-        return './';
-    }
-    else {
-        // If the types have different groups, then we have to go up a directory
-        return `../${getSanitizedGroup(referencedType, config)}/`;
-    }
-}
-function getTypeGroup(type, config) {
-    var _a, _b;
-    const groupAnnotation = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
-    return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : config.defaultGroupName;
-}
-function getSanitizedGroup(classModel, config) {
-    return getTypeGroup(classModel, config).replace(/ /g, '-').replace('.', '');
-}
-//# sourceMappingURL=generate-docs.js.map

package/lib/core/generate-docs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-docs.js","sourceRoot":"","sources":["../../src/core/generate-docs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,oCAkBC;AA7DD,6DAA0G;AAC1G,uDAA8D;AAE9D,yFAA6F;AAC7F,uFAA2F;AAC3F,iGAAqG;AACrG,gDAAkC;AAClC,6CAA4C;AAC5C,yCAA0D;AAC1D,iEAAyC;AACzC,iEAAqE;AACrE,6DAA6D;AAEhD,QAAA,YAAY,GAAG,IAAA,eAAI,EAAC,iCAAoB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;AAuBzF,MAAM,cAAc,GAAwB;IAC1C,KAAK,EAAE,CAAC,QAAQ,CAAC;IACjB,SAAS,EAAE,MAAM;IACjB,gBAAgB,EAAE,eAAe;IACjC,sBAAsB,EAAE,wCAAsB;CAC/C,CAAC;AAEF,SAAgB,YAAY,CAC1B,KAAe,EACf,MAAqC;IAErC,MAAM,kBAAkB,mCAAQ,cAAc,GAAK,MAAM,CAAE,CAAC;IAC5D,OAAO,IAAA,eAAI,EACT,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,EACvC,wBAAwB,EACxB,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACvE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC,EACxE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,EACpE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,cAAc,EAAE,IAAA,eAAI,EAAC,0BAA0B,CAAC,UAAU,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;QACvG,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,qBAAqB,CAAC;KAC7C,CAAC,CAAC,EACH,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CACpG,CAAC;AACJ,CAAC;AAeD,SAAS,uBAAuB,CAAC,KAAa,EAAE,MAA2B;IACzE,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;;QACZ,MAAM,UAAU,GAAG,IAAA,iCAAoB,EACrC,IAAI,EACJ,CAAC,aAAa,EAAE,EAAE;YAChB,OAAO,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QACvE,CAAC,EACD,MAAM,CAAC,SAAS,CACjB,CAAC;QACF,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,gBAAgB,CAAC;QAC3D,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;YACpC,WAAW,EAAE,IAAA,gCAAgB,EAAC,gBAAgB,EAAE,CAAC,aAAa,EAAE,EAAE;gBAChE,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;gBAC5C,OAAO,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YAC9D,CAAC,CAAC,CAAC,WAAW;SACf,CAAC;QAEF,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtC,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,EAAE;KAChB,CACF,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,UAAsB;IACnD,SAAS,cAAc,CAAC,UAAsB,EAAE,WAAmB;QACjE,OAAO;YACL,WAAW;YACX,QAAQ,EAAE,UAAU,CAAC,IAAI;YACzB,IAAI,EAAE,UAAU,CAAC,IAAI;SACtB,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,UAAU,EAAE,uBAAuB,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AACtH,CAAC;AAED,SAAS,0BAA0B,CACjC,UAAwD,EACxD,QAAgB;IAEhB,SAAS,qBAAqB,CAAC,UAAwD;QAGrF,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;aAC3B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aAClC,MAAM,CAA+C,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjE,GAAG,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAChG,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,UAAU,EAAE,qBAAqB,EAAE,CAAC,UAAU,EAAE,EAAE,CAC5D,OAAO,CAAC;QACN,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAa,EAAE,KAAe;IAC3D,OAAO,IAAI,kBAAQ,CAAC,KAAK,CAAC,CAAC,sCAAsC,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,wBAAwB,CAAC,gBAA0C;IAC1E,SAAS,sCAAsC,CAAC,OAAiC;QAI/E,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACd,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/E,OAAO,GAAG,CAAC;QACb,CAAC,EACD;YACE,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,EAAE;SACV,CACF,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,gBAAgB,EAAE,sCAAsC,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAC1F,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,MAAM,MAAM,GAAG,IAAA,yBAAgB,EAAC,KAAK,CAAC,CAAC;IACvC,oEAAoE;IACpE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,UAAW,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,uBAAuB,CAAC,UAAsB;IACrD,SAAS,WAAW,CAAC,UAAsB;QACzC,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;YACxB,KAAK,MAAM;gBACT,OAAO,oCAAoB,CAAC;YAC9B,KAAK,WAAW;gBACd,OAAO,8CAAyB,CAAC;YACnC,KAAK,OAAO;gBACV,OAAO,sCAAqB,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC;QACjC,MAAM,EAAE,UAA4B;KACrC,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAA2B;IAC1C,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,QAAQ,CAAC,UAAkB,EAAE,aAAqB;IACzD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;AAChH,CAAC;AAED,SAAS,mBAAmB,CAAiB,OAAU,EAAE,UAAkB;IACzE,IAAI,OAAO,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC;IACjB,CAAC;SAAM,IAAI,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;QAC7C,OAAO,4BAA4B,CAAC,OAA0B,EAAE,UAAU,CAAM,CAAC;IACnF,CAAC;SAAM,CAAC;QACN,OAAO,wBAAwB,CAAC,OAAsB,EAAE,UAAU,CAAM,CAAC;IAC3E,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CACjB,sBAAgD,EAChD,OAAU,EACV,UAAkB;IAElB,OAAO,IAAA,eAAI,EACT,sBAAsB,CAAC,OAAO,CAAC,EAC/B,CAAC,UAAoB,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,EACnH,CAAC,UAAU,GAAG,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAQ,EAC3E,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,MAAM,CACf,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,UAAU,CAAC,sBAAsB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EACtF,UAAU,CACX,CACJ,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,eAAgC,EAAE,UAAkB;IACxF,SAAS,mBAAmB,CAAC,UAAkB,EAAE,OAA2B;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,SAAS,eAAe,CAAC,eAAgC;QACvD,OAAO,eAAe,CAAC,mBAAmB,CAAC;IAC7C,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;IACzE,uCACK,eAAe,KAClB,OAAO,EAAE,OAAO,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC;YACrB,GAAG,GAAG;YACN,GAAG,YAAY,CAAC,OAAO;iBACpB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;iBAC1D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,SAAS,EAAE,IAAI,IACf,CAAC;SACN,EACD,eAAe,CAAC,OAAO,CACxB,IACD;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,WAAwB,EAAE,UAAkB;IAC5E,SAAS,mBAAmB,CAAC,UAAkB,EAAE,OAA2B;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,SAAS,eAAe,CAAC,WAAwB;QAC/C,OAAO,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,CAAC;IAED,SAAS,YAAY,CAAsD,OAAY,EAAE,QAAa;QACpG,OAAO,OAAO;aACX,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC;aACtE,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aAC/D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,SAAS,EAAE,IAAI,IACf,CAAC,CAAC;IACR,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACrE,uCACK,WAAW,KACd,MAAM,EAAE,OAAO,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAC1E,WAAW,CAAC,MAAM,CACnB,EACD,UAAU,EAAE,OAAO,CAAC,MAAM,CACxB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,EAC9E,WAAW,CAAC,UAAU,CACvB,EACD,OAAO,EAAE,OAAO,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,EAC3E,WAAW,CAAC,OAAO,CACpB,IACD;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,mBAAyB,EACzB,UAAkB,EAClB,aAAqB,EACrB,MAA2B;IAE3B,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IACjD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,iEAAiE;QACjE,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtF,OAAO;QACL,KAAK,EAAE,aAAa;QACpB,GAAG,EAAE,QAAQ;KACd,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,mBAAyB,EACzB,cAAoB,EACpB,MAA2B;IAE3B,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,MAAM,aAAa,GAAG,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC;IACzF,uHAAuH;IACvH,oDAAoD;IACpD,MAAM,aAAa,GAAG,GAAG,eAAe,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;IACjE,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,eAAe,CAAC,MAA2B,EAAE,IAAW;IAC/D,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,OAAO;QACL,KAAK,EAAE,GAAG,eAAe,GAAG,IAAI,CAAC,IAAI,EAAE;QACvC,GAAG,EAAE,KAAK,eAAe,GAAG,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK;KAC9E,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,mBAAyB,EAAE,cAAoB,EAAE,MAA2B;IACpG,IAAI,YAAY,CAAC,mBAAmB,EAAE,MAAM,CAAC,KAAK,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC;QACvF,yEAAyE;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,CAAC;QACN,wEAAwE;QACxE,OAAO,MAAM,iBAAiB,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG,CAAC;IAC5D,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAU,EAAE,MAA2B;;IAC3D,MAAM,eAAe,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,CAAC;IACrH,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,MAAM,CAAC,gBAAgB,CAAC;AAC1D,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAgB,EAAE,MAA2B;IACtE,OAAO,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC9E,CAAC"}

package/lib/core/template.d.ts

@@ -1,10 +0,0 @@
-export type CompilationRequest = {
-    template: string;
-    source: unknown;
-};
-export declare class Template {
-    private static instance;
-    private constructor();
-    static getInstance(): Template;
-    compile(request: CompilationRequest): string;
-}

package/lib/core/template.js

@@ -1,92 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Template = void 0;
-const handlebars_1 = __importDefault(require("handlebars"));
-const type_doc_partial_1 = require("../transpiler/markdown/plain-markdown/type-doc-partial");
-const documentable_partial_template_1 = require("../transpiler/markdown/plain-markdown/documentable-partial-template");
-const methods_partial_template_1 = require("../transpiler/markdown/plain-markdown/methods-partial-template");
-const constructors_partial_template_1 = require("../transpiler/markdown/plain-markdown/constructors-partial-template");
-const fieldsPartialTemplate_1 = require("../transpiler/markdown/plain-markdown/fieldsPartialTemplate");
-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 type_utils_1 = require("../adapters/type-utils");
-const grouped_members_partial_template_1 = require("../transpiler/markdown/plain-markdown/grouped-members-partial-template");
-class Template {
-    constructor() {
-        handlebars_1.default.registerPartial('typeDocumentation', type_doc_partial_1.typeDocPartial);
-        handlebars_1.default.registerPartial('documentablePartialTemplate', documentable_partial_template_1.documentablePartialTemplate);
-        handlebars_1.default.registerPartial('methodsPartialTemplate', methods_partial_template_1.methodsPartialTemplate);
-        handlebars_1.default.registerPartial('constructorsPartialTemplate', constructors_partial_template_1.constructorsPartialTemplate);
-        handlebars_1.default.registerPartial('groupedMembersPartialTemplate', grouped_members_partial_template_1.groupedMembersPartialTemplate);
-        handlebars_1.default.registerPartial('fieldsPartialTemplate', fieldsPartialTemplate_1.fieldsPartialTemplate);
-        handlebars_1.default.registerPartial('classTemplate', class_template_1.classMarkdownTemplate);
-        handlebars_1.default.registerPartial('enumTemplate', enum_template_1.enumMarkdownTemplate);
-        handlebars_1.default.registerPartial('interfaceTemplate', interface_template_1.interfaceMarkdownTemplate);
-        handlebars_1.default.registerHelper('link', link);
-        handlebars_1.default.registerHelper('code', convertCodeBlock);
-        handlebars_1.default.registerHelper('withLinks', resolveLinksInContent);
-        handlebars_1.default.registerHelper('heading', heading);
-        handlebars_1.default.registerHelper('inlineCode', inlineCode);
-        handlebars_1.default.registerHelper('splitAndCapitalize', splitAndCapitalize);
-    }
-    static getInstance() {
-        if (!Template.instance) {
-            Template.instance = new Template();
-        }
-        return Template.instance;
-    }
-    compile(request) {
-        const compiled = handlebars_1.default.compile(request.template);
-        return (compiled(request.source)
-            .trim()
-            // clean up extra newlines
-            .replace(/\n{3,}/g, '\n\n'));
-    }
-}
-exports.Template = Template;
-const splitAndCapitalize = (text) => {
-    const words = text.split(/[-_]+/);
-    const capitalizedWords = [];
-    for (const word of words) {
-        capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
-    }
-    return capitalizedWords.join(' ');
-};
-const heading = (level, text) => {
-    return `${'#'.repeat(level)} ${text}`;
-};
-const inlineCode = (text) => {
-    return new handlebars_1.default.SafeString(`\`${text}\``);
-};
-const convertCodeBlock = (language, lines) => {
-    return new handlebars_1.default.SafeString(`
-\`\`\`${language}
-${lines.join('\n')}
-\`\`\`
-  `.trim());
-};
-const resolveLinksInContent = (description) => {
-    if (!description) {
-        return '';
-    }
-    function reduceDescription(acc, curr) {
-        if ((0, type_utils_1.isEmptyLine)(curr)) {
-            return acc + '\n\n';
-        }
-        return acc + link(curr).trim() + ' ';
-    }
-    return description.reduce(reduceDescription, '').trim();
-};
-const link = (source) => {
-    if (typeof source === 'string') {
-        return source;
-    }
-    else {
-        return `[${source.title}](${source.url})`;
-    }
-};
-//# sourceMappingURL=template.js.map

package/lib/core/template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"template.js","sourceRoot":"","sources":["../../src/core/template.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AACpC,6FAAwF;AACxF,uHAAkH;AAClH,6GAAwG;AACxG,uHAAkH;AAClH,uGAAoG;AACpG,yFAA6F;AAC7F,uFAA2F;AAC3F,iGAAqG;AAErG,uDAAqD;AACrD,6HAAuH;AAOvH,MAAa,QAAQ;IAGnB;QACE,oBAAU,CAAC,eAAe,CAAC,mBAAmB,EAAE,iCAAc,CAAC,CAAC;QAChE,oBAAU,CAAC,eAAe,CAAC,6BAA6B,EAAE,2DAA2B,CAAC,CAAC;QACvF,oBAAU,CAAC,eAAe,CAAC,wBAAwB,EAAE,iDAAsB,CAAC,CAAC;QAC7E,oBAAU,CAAC,eAAe,CAAC,6BAA6B,EAAE,2DAA2B,CAAC,CAAC;QACvF,oBAAU,CAAC,eAAe,CAAC,+BAA+B,EAAE,gEAA6B,CAAC,CAAC;QAC3F,oBAAU,CAAC,eAAe,CAAC,uBAAuB,EAAE,6CAAqB,CAAC,CAAC;QAC3E,oBAAU,CAAC,eAAe,CAAC,eAAe,EAAE,sCAAqB,CAAC,CAAC;QACnE,oBAAU,CAAC,eAAe,CAAC,cAAc,EAAE,oCAAoB,CAAC,CAAC;QACjE,oBAAU,CAAC,eAAe,CAAC,mBAAmB,EAAE,8CAAyB,CAAC,CAAC;QAE3E,oBAAU,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACxC,oBAAU,CAAC,cAAc,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACpD,oBAAU,CAAC,cAAc,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC;QAC9D,oBAAU,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC9C,oBAAU,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACpD,oBAAU,CAAC,cAAc,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACvB,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,OAAO,CAAC,OAA2B;QACjC,MAAM,QAAQ,GAAG,oBAAU,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAO,CACL,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;aACrB,IAAI,EAAE;YACP,0BAA0B;aACzB,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;CACF;AAtCD,4BAsCC;AAED,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,EAAE;IAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,IAAY,EAAE,EAAE;IAC9C,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE;IAClC,OAAO,IAAI,oBAAU,CAAC,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,KAAe,EAAyB,EAAE;IACpF,OAAO,IAAI,oBAAU,CAAC,UAAU,CAC9B;QACI,QAAQ;EACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;;GAEf,CAAC,IAAI,EAAE,CACP,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,WAAiC,EAAU,EAAE;IAC1E,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,SAAS,iBAAiB,CAAC,GAAW,EAAE,IAAuB;QAC7D,IAAI,IAAA,wBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,GAAG,GAAG,MAAM,CAAC;QACtB,CAAC;QAED,OAAO,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC;IACvC,CAAC;IAED,OAAO,WAAW,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,CAAC,MAAoB,EAAU,EAAE;IAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,GAAG,GAAG,CAAC;IAC5C,CAAC;AACH,CAAC,CAAC"}

package/lib/core/templates/reference-guide.d.ts

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

package/lib/core/templates/reference-guide.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.referenceGuideTemplate = void 0;
-exports.referenceGuideTemplate = `
-# Apex Reference Guide
-
-{{#each this}}
-## {{@key}}
-
-{{#each this}}
-### {{link title}}
-
-{{withLinks description}}
-
-{{/each}}
-{{/each}}
-`.trim();
-//# sourceMappingURL=reference-guide.js.map

package/lib/core/templates/reference-guide.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"reference-guide.js","sourceRoot":"","sources":["../../../src/core/templates/reference-guide.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;;;;;;;;;;;;;CAarC,CAAC,IAAI,EAAE,CAAC"}

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-import * as reflection from '@cparra/apex-reflection';
-export { reflection };

package/lib/index.js

@@ -1,29 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.reflection = void 0;
-const reflection = __importStar(require("@cparra/apex-reflection"));
-exports.reflection = reflection;
-//# sourceMappingURL=index.js.map

package/lib/index.js.map

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

package/lib/model/apex-bundle.d.ts

@@ -1,6 +0,0 @@
-export default class ApexBundle {
-    filePath: string;
-    rawTypeContent: string;
-    rawMetadataContent: string | null;
-    constructor(filePath: string, rawTypeContent: string, rawMetadataContent: string | null);
-}

package/lib/model/apex-bundle.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class ApexBundle {
-    constructor(filePath, rawTypeContent, rawMetadataContent) {
-        this.filePath = filePath;
-        this.rawTypeContent = rawTypeContent;
-        this.rawMetadataContent = rawMetadataContent;
-    }
-}
-exports.default = ApexBundle;
-//# sourceMappingURL=apex-bundle.js.map

package/lib/model/apex-bundle.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"apex-bundle.js","sourceRoot":"","sources":["../../src/model/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"}