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

package/lib/transpiler/markdown/class-file-generatorHelper.d.ts

@@ -1,11 +0,0 @@
-import { Type } from '@cparra/apex-reflection';
-import { StringOrLink } from '../../templating/types';
-export default class ClassFileGeneratorHelper {
-    static getSanitizedGroup(classModel: Type): string;
-    static getFileLink(classModel: Type): string;
-    private static getFileLinkTuple;
-    static getFileLinkByTypeName(typeName: string): string;
-    static getRenderableLinkByTypeName(typeName: string): StringOrLink;
-    private static getDirectoryRoot;
-    private static getClassGroup;
-}

package/lib/transpiler/markdown/class-file-generatorHelper.js

@@ -1,75 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const types_repository_1 = require("../../model/types-repository");
-const settings_1 = require("../../settings");
-const state_1 = __importDefault(require("../../service/state"));
-const factory_1 = require("../factory");
-class ClassFileGeneratorHelper {
-    static getSanitizedGroup(classModel) {
-        return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
-    }
-    static getFileLink(classModel) {
-        const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(classModel);
-        return `[${fullClassName}](${fileLink})`;
-    }
-    static getFileLinkTuple(classModel) {
-        var _a;
-        const documentationRoot = (_a = settings_1.Settings.getInstance().getRootDir()) !== null && _a !== void 0 ? _a : '';
-        const directoryRoot = `${documentationRoot}${this.getDirectoryRoot(classModel)}`;
-        const fullClassName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${classModel.name}`;
-        return [fullClassName, `${directoryRoot}${fullClassName}.md`];
-    }
-    static getFileLinkByTypeName(typeName) {
-        const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
-        if (!type) {
-            // If the type is not found, we return a Markdown hyperlink with whatever we received.
-            return `[${typeName}](${typeName})`;
-        }
-        return this.getFileLink(type);
-    }
-    static getRenderableLinkByTypeName(typeName) {
-        const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
-        if (!type) {
-            // If the type is not found, we return the type name as a string.
-            return typeName;
-        }
-        const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(type);
-        return {
-            title: fullClassName,
-            url: fileLink,
-        };
-    }
-    static getDirectoryRoot(classModel) {
-        // root-relative links start from the root by using a leading '/'
-        const generator = settings_1.Settings.getInstance().targetGenerator;
-        if (factory_1.TypeTranspilerFactory.get(generator).getLinkingStrategy() === 'root-relative') {
-            return `/${this.getSanitizedGroup(classModel)}/`;
-        }
-        // path-relative links traverse the directory structure
-        const typeBeingProcessed = state_1.default.getInstance().getTypeBeingProcessed();
-        if (typeBeingProcessed) {
-            if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
-                // 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 `../${this.getSanitizedGroup(classModel)}/`;
-            }
-        }
-        else {
-            // If nothing is being processed, then we assume we are at the root and links should include the groups
-            return `./${this.getSanitizedGroup(classModel)}/`;
-        }
-    }
-    static getClassGroup(classModel) {
-        var _a, _b;
-        const groupAnnotation = (_a = classModel.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 : settings_1.Settings.getInstance().getDefaultGroupName();
-    }
-}
-exports.default = ClassFileGeneratorHelper;
-//# sourceMappingURL=class-file-generatorHelper.js.map

package/lib/transpiler/markdown/class-file-generatorHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;;;;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,gEAAwC;AACxC,wCAAmD;AAGnD,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxF,OAAO,IAAI,aAAa,KAAK,QAAQ,GAAG,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;;QAC9C,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,2BAA2B,CAAC,QAAgB;QACxD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,iEAAiE;YACjE,OAAO,QAAQ,CAAC;SACjB;QAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClF,OAAO;YACL,KAAK,EAAE,aAAa;YACpB,GAAG,EAAE,QAAQ;SACd,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YACjF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SAClD;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAC7E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,uGAAuG;YACvG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAtED,2CAsEC"}

package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts

@@ -1,6 +0,0 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
-export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
-    homeFileName(): string;
-    getLinkingStrategy(): LinkingStrategy;
-}

package/lib/transpiler/markdown/docsify/docsify-docs-processor.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
-class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
-    homeFileName() {
-        return 'README';
-    }
-    getLinkingStrategy() {
-        return 'root-relative';
-    }
-}
-exports.default = DocsifyDocsProcessor;
-//# sourceMappingURL=docsify-docs-processor.js.map

package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAGrE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,uCAQC"}

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts

@@ -1,11 +0,0 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { Type } from '@cparra/apex-reflection';
-import { LinkingStrategy } from '../../processor-type-transpiler';
-export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
-    homeFileName(): string;
-    onBeforeProcess: (types: Type[]) => void;
-    onProcess(type: Type): void;
-    get frontMatterForHomeFile(): string;
-    getFrontMatterHeader(type: Type): string;
-    getLinkingStrategy(): LinkingStrategy;
-}

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.JekyllDocsProcessor = void 0;
-const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
-const markdown_home_file_1 = require("../../../model/markdown-home-file");
-const markdown_type_file_1 = require("../../../model/markdown-type-file");
-const settings_1 = require("../../../settings");
-class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
-    constructor() {
-        super(...arguments);
-        this.onBeforeProcess = (types) => {
-            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
-        };
-    }
-    homeFileName() {
-        return 'index';
-    }
-    onProcess(type) {
-        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
-    }
-    get frontMatterForHomeFile() {
-        return '---\nlayout: default\n---';
-    }
-    getFrontMatterHeader(type) {
-        var _a;
-        const headerLines = ['---'];
-        // "layout: default" is a required front matter header for Jekyll
-        headerLines.push('layout: default');
-        // Add any additional front matter headers that might have been configured in the settings
-        const targetType = {
-            name: type.name,
-            typeName: type.type_name,
-            accessModifier: type.access_modifier,
-            group: type.group,
-            description: (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description,
-        };
-        const configuredHeaders = settings_1.Settings.getInstance().frontMatterHeader(targetType);
-        if (configuredHeaders) {
-            configuredHeaders.forEach((header) => {
-                headerLines.push(header);
-            });
-        }
-        headerLines.push('---');
-        return headerLines.join('\n');
-    }
-    getLinkingStrategy() {
-        return 'path-relative';
-    }
-}
-exports.JekyllDocsProcessor = JekyllDocsProcessor;
-//# sourceMappingURL=jekyll-docsProcessor.js.map

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAErE,gDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAC;IAmCJ,CAAC;IAzCC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,oBAAoB,CAAC,IAAU;;QAC7B,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,iEAAiE;QACjE,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,0FAA0F;QAC1F,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC;QACF,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,iBAAiB,EAAE;YACrB,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACnC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;SACJ;QACD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AA1CD,kDA0CC"}

package/lib/transpiler/markdown/markdown-transpiler-base.d.ts

@@ -1,11 +0,0 @@
-import ProcessorTypeTranspiler from '../processor-type-transpiler';
-import { Type } from '@cparra/apex-reflection';
-import { FileContainer } from '../file-container';
-export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
-    protected readonly _fileContainer: FileContainer;
-    constructor();
-    abstract homeFileName(): string;
-    fileBuilder(): FileContainer;
-    onBeforeProcess: (types: Type[]) => void;
-    onProcess(type: Type): void;
-}

package/lib/transpiler/markdown/markdown-transpiler-base.js

@@ -1,27 +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.MarkdownTranspilerBase = void 0;
-const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
-const file_container_1 = require("../file-container");
-const markdown_home_file_1 = require("../../model/markdown-home-file");
-const markdown_type_file_1 = require("../../model/markdown-type-file");
-class MarkdownTranspilerBase extends processor_type_transpiler_1.default {
-    constructor() {
-        super();
-        this.onBeforeProcess = (types) => {
-            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
-        };
-        this._fileContainer = new file_container_1.FileContainer();
-    }
-    fileBuilder() {
-        return this._fileContainer;
-    }
-    onProcess(type) {
-        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type));
-    }
-}
-exports.MarkdownTranspilerBase = MarkdownTranspilerBase;
-//# sourceMappingURL=markdown-transpiler-base.js.map

package/lib/transpiler/markdown/markdown-transpiler-base.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}

package/lib/transpiler/markdown/plain-markdown/class-template.d.ts

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

package/lib/transpiler/markdown/plain-markdown/class-template.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.classMarkdownTemplate = void 0;
-exports.classMarkdownTemplate = `
-# {{name}} Class
-{{#if classModifier}}
-\`{{classModifier}}\`
-{{/if}}
-
-{{> typeLevelApexDocPartialTemplate}}
-
-{{#if extends}}
-**Extends**
-{{extends}}
-{{/if}}
-
-{{#if implements}}
-**Implements**
-{{#each implements}}
-{{this}}{{#unless @last}}, {{/unless}}
-{{/each}}
-{{/if}}
-
-{{#if fields}}
-{{> fieldsPartialTemplate}}
-{{/if}}
-
-{{#if constructors}}
-{{> constructorsPartialTemplate}}
-{{/if}}
-
-{{#if methods}}
-{{> methodsPartialTemplate}}
-{{/if}}
-`.trim();
-//# sourceMappingURL=class-template.js.map

package/lib/transpiler/markdown/plain-markdown/class-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"class-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/class-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BpC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts

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

package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.constructorsPartialTemplate = void 0;
-exports.constructorsPartialTemplate = `
-## Constructors
-{{#each constructors}}
-### \`{{title}}\`
-
-{{#> documentablePartialTemplate}}
-
-### Signature
-\`\`\`apex
-{{signature}}
-\`\`\` 
-
-{{#if parameters}}
-### Parameters
-| Name | Type | Description |
-|------|------|-------------|
-{{#each parameters}}
-| {{name}} | {{type}} | {{description}} |
-{{/each}}
-{{/if}}
-
-{{#if throws}}
-### Throws
-{{#each throws}}
-{{this.type}}: {{this.description}}
-
-{{/each}}
-{{/if}}
-
-{{/documentablePartialTemplate}}
-
-{{#unless @last}}---{{/unless}}
-{{/each}}
-
-`.trim();
-//# sourceMappingURL=constructors-partial-template.js.map

package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constructors-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/constructors-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkC1C,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts

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

package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.documentablePartialTemplate = void 0;
-exports.documentablePartialTemplate = `
-{{#each annotations}}
-\`{{this}}\`
-{{/each}}
-
-{{description}}
-
-{{#each customTags}}
-**{{splitAndCapitalize name}}** {{description}}
-
-{{/each}}
-
-{{> @partial-block}}
-
-{{{mermaid}}}
-
-{{#if example}}
-##{{#if isInner}}#{{/if}} Example
-{{{example}}}
-{{/if}}
-`.trim();
-//# sourceMappingURL=documentable-partial-template.js.map

package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"documentable-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/documentable-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;CAoB1C,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts

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

package/lib/transpiler/markdown/plain-markdown/enum-template.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enumMarkdownTemplate = void 0;
-exports.enumMarkdownTemplate = `
-# {{name}} Enum
-
-{{> typeLevelApexDocPartialTemplate}}
-
-## Enum Values
-{{#each values}}
-### {{value}}
-{{description}}
-{{/each}}
-`.trim();
-//# sourceMappingURL=enum-template.js.map

package/lib/transpiler/markdown/plain-markdown/enum-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"enum-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/enum-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG;;;;;;;;;;CAUnC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts

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

package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fieldsPartialTemplate = void 0;
-exports.fieldsPartialTemplate = `
-## Fields
-{{#each fields}}
-### \`\{{name}}\`
-
-{{#if inherited}}
-*Inherited*
-{{/if}}
-
-{{#> documentablePartialTemplate}}
-
-#### Type
-{{type}}
-
-{{/documentablePartialTemplate}}
-
-{{#unless @last}}---{{/unless}}
-
-{{/each}}
-`.trim();
-//# sourceMappingURL=fieldsPartialTemplate.js.map

package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fieldsPartialTemplate.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;CAmBpC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts

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

package/lib/transpiler/markdown/plain-markdown/interface-template.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.interfaceMarkdownTemplate = void 0;
-exports.interfaceMarkdownTemplate = `
-# {{name}} Interface
-
-{{> typeLevelApexDocPartialTemplate}}
-
-{{#if extends}}
-**Extends**
-{{#each extends}}
-{{this}}{{#unless @last}}, {{/unless}}
-{{/each}}
-{{/if}}
-
-{{#if methods}}
-{{> methodsPartialTemplate}}
-{{/if}}
-`.trim();
-//# sourceMappingURL=interface-template.js.map

package/lib/transpiler/markdown/plain-markdown/interface-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interface-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/interface-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,yBAAyB,GAAG;;;;;;;;;;;;;;;CAexC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts

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

package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.methodsPartialTemplate = void 0;
-exports.methodsPartialTemplate = `
-## Methods
-{{#each methods}}
-### \`{{title}}\`
-
-{{#if inherited}}
-*Inherited*
-{{/if}}
-
-{{#> documentablePartialTemplate isInner=true}}
-
-### Signature
-\`\`\`apex
-{{signature}}
-\`\`\` 
-
-{{#if parameters}}
-### Parameters
-| Name | Type | Description |
-|------|------|-------------|
-{{#each parameters}}
-| {{name}} | {{type}} | {{description}} |
-{{/each}}
-{{/if}}
-
-{{#if returnType}}
-### Returns
-**{{returnType.type}}**
-
-{{returnType.description}}
-{{/if}}
-
-{{#if throws}}
-### Throws
-{{#each throws}}
-{{this.type}}: {{this.description}}
-
-{{/each}}
-{{/if}}
-{{/documentablePartialTemplate}}
-
-{{#unless @last}}---{{/unless}}
-
-{{/each}}
-`.trim();
-//# sourceMappingURL=methods-partial-template.js.map

package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"methods-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/methods-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4CrC,CAAC,IAAI,EAAE,CAAC"}

package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts

@@ -1,13 +0,0 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
-import { Type } from '@cparra/apex-reflection';
-import { OutputFile } from '../../../model/outputFile';
-export declare class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
-    _fileContents: string[];
-    onBeforeProcess: (types: Type[]) => void;
-    homeFileName(): string;
-    getLinkingStrategy(): LinkingStrategy;
-    onProcess(type: Type): void;
-    onAfterProcess: (types: Type[]) => void;
-    _generateOutputFile(type: Type): OutputFile;
-}

package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js

@@ -1,122 +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.PlainMarkdownDocsProcessor = void 0;
-const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
-const outputFile_1 = require("../../../model/outputFile");
-const settings_1 = require("../../../settings");
-const class_file_generatorHelper_1 = __importDefault(require("../class-file-generatorHelper"));
-const enum_template_1 = require("./enum-template");
-const compile_1 = require("../../../templating/compile");
-const interface_template_1 = require("./interface-template");
-const class_template_1 = require("./class-template");
-const type_utils_1 = require("../../../adapters/type-utils");
-const apex_types_1 = require("../../../adapters/apex-types");
-const markdown_home_file_1 = require("../../../model/markdown-home-file");
-const markdown_file_1 = require("../../../model/markdown-file");
-const handlebars_1 = __importDefault(require("handlebars"));
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-class PlainMarkdownDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
-    constructor() {
-        super(...arguments);
-        this._fileContents = [];
-        this.onBeforeProcess = (types) => {
-            if (settings_1.Settings.getInstance().shouldOutputSingleFile()) {
-                return;
-            }
-            else {
-                this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
-            }
-        };
-        this.onAfterProcess = () => {
-            if (settings_1.Settings.getInstance().shouldOutputSingleFile()) {
-                const file = new markdown_file_1.MarkdownFile(settings_1.Settings.getInstance().getSingleFileName(), '');
-                let contents;
-                if (settings_1.Settings.getInstance().getTemplateFilePath()) {
-                    const filePath = path_1.default.resolve(settings_1.Settings.getInstance().getTemplateFilePath());
-                    const templateFileContents = fs_1.default.readFileSync(filePath, {
-                        encoding: 'utf-8',
-                    });
-                    const handlebars = handlebars_1.default.compile(templateFileContents);
-                    contents = handlebars({ api_docs: this._fileContents.join('\n\n---\n\n') });
-                }
-                else {
-                    contents = this._fileContents.join('\n\n---\n\n');
-                }
-                file.addText(contents);
-                this._fileContainer.pushFile(file);
-            }
-        };
-    }
-    homeFileName() {
-        return 'index';
-    }
-    getLinkingStrategy() {
-        return 'path-relative';
-    }
-    onProcess(type) {
-        if (settings_1.Settings.getInstance().shouldOutputSingleFile()) {
-            this._fileContents.push(this._generateOutputFile(type).body);
-        }
-        else {
-            this._fileContainer.pushFile(this._generateOutputFile(type));
-        }
-    }
-    _generateOutputFile(type) {
-        if (type.type_name === 'enum') {
-            return new GenericFile(type, apex_types_1.enumTypeToEnumSource, enum_template_1.enumMarkdownTemplate);
-        }
-        else if (type.type_name === 'interface') {
-            return new GenericFile(type, apex_types_1.interfaceTypeToInterfaceSource, interface_template_1.interfaceMarkdownTemplate);
-        }
-        else {
-            return new GenericFile(type, apex_types_1.classTypeToClassSource, class_template_1.classMarkdownTemplate);
-        }
-    }
-}
-exports.PlainMarkdownDocsProcessor = PlainMarkdownDocsProcessor;
-class GenericFile extends outputFile_1.OutputFile {
-    constructor(type, toSource, template) {
-        super(`${settings_1.Settings.getInstance().getNamespacePrefix()}${type.name}`, class_file_generatorHelper_1.default.getSanitizedGroup(type));
-        this.type = type;
-        const source = toSource(type);
-        this.addText((0, compile_1.compile)(template, source, {
-            renderableContentConverter: prepareDescription,
-            codeBlockConverter: convertCodeBlock,
-        }));
-    }
-    fileExtension() {
-        return '.md';
-    }
-}
-function prepareDescription(description) {
-    if (!description) {
-        return '';
-    }
-    function reduceDescription(acc, curr) {
-        if (typeof curr === 'string') {
-            return acc + curr.trim() + ' ';
-        }
-        else if ((0, type_utils_1.isEmptyLine)(curr)) {
-            return acc + '\n\n';
-        }
-        else {
-            return acc + linkToMarkdown(curr) + ' ';
-        }
-    }
-    function linkToMarkdown(link) {
-        return `[${link.title}](${link.url})`;
-    }
-    return description.reduce(reduceDescription, '').trim();
-}
-function convertCodeBlock(language, lines) {
-    return `
-\`\`\`${language}
-${lines.join('\n')}
-\`\`\`
-  `.trim();
-}
-//# sourceMappingURL=plain-docsProcessor.js.map

package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plain-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts"],"names":[],"mappings":";;;;;;AAAA,0EAAqE;AAGrE,0DAAuD;AACvD,gDAA6C;AAC7C,+FAAqE;AACrE,mDAAuD;AACvD,yDAAsD;AAEtD,6DAAiE;AACjE,qDAAyD;AACzD,6DAA2D;AAC3D,6DAIsC;AACtC,0EAAqE;AACrE,gEAA4D;AAC5D,4DAAoC;AACpC,4CAAoB;AACpB,gDAAwB;AAExB,MAAa,0BAA2B,SAAQ,iDAAsB;IAAtE;;QACE,kBAAa,GAAa,EAAE,CAAC;QAC7B,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,sBAAsB,EAAE,EAAE;gBACnD,OAAO;aACR;iBAAM;gBACL,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;aAChF;QACH,CAAC,CAAC;QAkBF,mBAAc,GAA4B,GAAG,EAAE;YAC7C,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,sBAAsB,EAAE,EAAE;gBACnD,MAAM,IAAI,GAAG,IAAI,4BAAY,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,EAAE,EAAE,EAAE,CAAC,CAAC;gBAE9E,IAAI,QAAQ,CAAC;gBACb,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,EAAE;oBAChD,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAG,CAAC,CAAC;oBAC7E,MAAM,oBAAoB,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;wBACrD,QAAQ,EAAE,OAAO;qBAClB,CAAC,CAAC;oBACH,MAAM,UAAU,GAAG,oBAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;oBAC5D,QAAQ,GAAG,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;iBAC7E;qBAAM;oBACL,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;iBACnD;gBACD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACvB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aACpC;QACH,CAAC,CAAC;IAeJ,CAAC;IAjDC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,SAAS,CAAC,IAAU;QAClB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,sBAAsB,EAAE,EAAE;YACnD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;SAC9D;aAAM;YACL,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9D;IACH,CAAC;IAsBD,mBAAmB,CAAC,IAAU;QAC5B,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,EAAE;YAC7B,OAAO,IAAI,WAAW,CAAa,IAAkB,EAAE,iCAAoB,EAAE,oCAAoB,CAAC,CAAC;SACpG;aAAM,IAAI,IAAI,CAAC,SAAS,KAAK,WAAW,EAAE;YACzC,OAAO,IAAI,WAAW,CACpB,IAAuB,EACvB,2CAA8B,EAC9B,8CAAyB,CAC1B,CAAC;SACH;aAAM;YACL,OAAO,IAAI,WAAW,CAAc,IAAmB,EAAE,mCAAsB,EAAE,sCAAqB,CAAC,CAAC;SACzG;IACH,CAAC;CACF;AA3DD,gEA2DC;AAED,MAAM,WAA4B,SAAQ,uBAAU;IAClD,YAAoB,IAAO,EAAE,QAAiE,EAAE,QAAgB;QAC9G,KAAK,CACH,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,EAC5D,oCAAwB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CACjD,CAAC;QAJgB,SAAI,GAAJ,IAAI,CAAG;QAMzB,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,OAAO,CACV,IAAA,iBAAO,EAAC,QAAQ,EAAE,MAAM,EAAE;YACxB,0BAA0B,EAAE,kBAAkB;YAC9C,kBAAkB,EAAE,gBAAgB;SACrC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,SAAS,kBAAkB,CAAC,WAAiC;IAC3D,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,EAAE,CAAC;KACX;IAED,SAAS,iBAAiB,CAAC,GAAW,EAAE,IAAuB;QAC7D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC;SAChC;aAAM,IAAI,IAAA,wBAAW,EAAC,IAAI,CAAC,EAAE;YAC5B,OAAO,GAAG,GAAG,MAAM,CAAC;SACrB;aAAM;YACL,OAAO,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;SACzC;IACH,CAAC;IAED,SAAS,cAAc,CAAC,IAAU;QAChC,OAAO,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC;IACxC,CAAC;IAED,OAAO,WAAW,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAC1D,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAgB,EAAE,KAAe;IACzD,OAAO;QACD,QAAQ;EACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;;GAEf,CAAC,IAAI,EAAE,CAAC;AACX,CAAC"}