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

package/lib/templating/compile.js

@@ -1,98 +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.compile = void 0;
-const handlebars_1 = __importDefault(require("handlebars"));
-const helpers_1 = require("./helpers");
-const type_level_apex_doc_partial_template_1 = require("../transpiler/markdown/plain-markdown/type-level-apex-doc-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 documentable_partial_template_1 = require("../transpiler/markdown/plain-markdown/documentable-partial-template");
-function compile(template, source, options) {
-    handlebars_1.default.registerPartial('typeLevelApexDocPartialTemplate', type_level_apex_doc_partial_template_1.typeLevelApexDocPartialTemplate);
-    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('fieldsPartialTemplate', fieldsPartialTemplate_1.fieldsPartialTemplate);
-    handlebars_1.default.registerHelper('splitAndCapitalize', helpers_1.splitAndCapitalize);
-    const prepared = Object.assign(Object.assign({}, prepare(source, options)), { namespace: (0, helpers_1.namespace)() });
-    const compiled = handlebars_1.default.compile(template);
-    return (compiled(prepared)
-        .trim()
-        // clean up extra newlines
-        .replace(/\n{3,}/g, '\n\n'));
-}
-exports.compile = compile;
-function prepare(source, { renderableContentConverter, codeBlockConverter }) {
-    const base = Object.assign(Object.assign(Object.assign({}, source), prepareDocumentable(source, renderableContentConverter, codeBlockConverter)), prepareBaseType(source, renderableContentConverter));
-    if (isEnumSource(source)) {
-        return Object.assign(Object.assign({}, base), prepareEnum(source, renderableContentConverter));
-    }
-    else if (isInterfaceSource(source)) {
-        return Object.assign(Object.assign({}, base), prepareInterface(source, renderableContentConverter, codeBlockConverter));
-    }
-    else {
-        return Object.assign(Object.assign({}, base), prepareClass(source, renderableContentConverter, codeBlockConverter));
-    }
-}
-function prepareDocumentable(source, renderableContentConverter, codeBlockConverter) {
-    var _a;
-    return {
-        description: renderableContentConverter(source.description),
-        mermaid: source.mermaid ? codeBlockConverter('mermaid', source.mermaid) : undefined,
-        example: source.example ? codeBlockConverter('apex', source.example) : undefined,
-        customTags: (_a = source.customTags) === null || _a === void 0 ? void 0 : _a.map((tag) => ({
-            name: tag.name,
-            value: renderableContentConverter(tag.description),
-        })),
-    };
-}
-function prepareBaseType(source, renderableContentConverter) {
-    var _a;
-    return {
-        sees: (_a = source.sees) === null || _a === void 0 ? void 0 : _a.map((see) => renderableContentConverter([see])),
-    };
-}
-function prepareEnum(source, renderableContentConverter) {
-    return {
-        values: source.values.map((value) => ({
-            value: value.value,
-            description: renderableContentConverter(value.description),
-        })),
-    };
-}
-function prepareInterface(source, renderableContentConverter, codeBlockConverter) {
-    var _a, _b;
-    return {
-        extends: (_a = source.extends) === null || _a === void 0 ? void 0 : _a.map((ext) => renderableContentConverter([ext])),
-        methods: (_b = source.methods) === null || _b === void 0 ? void 0 : _b.map((method) => mapMethod(method, renderableContentConverter, codeBlockConverter)),
-    };
-}
-function prepareClass(source, renderableContentConverter, codeBlockConverter) {
-    var _a, _b, _c, _d;
-    return {
-        implements: (_a = source.implements) === null || _a === void 0 ? void 0 : _a.map((impl) => renderableContentConverter([impl])),
-        extends: source.extends ? renderableContentConverter([source.extends]) : undefined,
-        constructors: (_b = source.constructors) === null || _b === void 0 ? void 0 : _b.map((constructor) => mapConstructor(constructor, renderableContentConverter, codeBlockConverter)),
-        methods: (_c = source.methods) === null || _c === void 0 ? void 0 : _c.map((method) => mapMethod(method, renderableContentConverter, codeBlockConverter)),
-        fields: (_d = source.fields) === null || _d === void 0 ? void 0 : _d.map((field) => (Object.assign(Object.assign(Object.assign({}, field), prepareDocumentable(field, renderableContentConverter, codeBlockConverter)), { type: renderableContentConverter([field.type]) }))),
-    };
-}
-function mapMethod(method, renderableContentConverter, codeBlockConverter) {
-    var _a, _b, _c, _d;
-    return Object.assign(Object.assign(Object.assign({}, method), prepareDocumentable(method, renderableContentConverter, codeBlockConverter)), { returnType: Object.assign(Object.assign({}, method), { type: ((_a = method.returnType) === null || _a === void 0 ? void 0 : _a.type) ? renderableContentConverter([method.returnType.type]) : undefined, description: renderableContentConverter((_b = method.returnType) === null || _b === void 0 ? void 0 : _b.description) }), throws: (_c = method.throws) === null || _c === void 0 ? void 0 : _c.map((thrown) => (Object.assign(Object.assign({}, thrown), { type: renderableContentConverter([thrown.type]), description: renderableContentConverter(thrown.description) }))), parameters: (_d = method.parameters) === null || _d === void 0 ? void 0 : _d.map((param) => (Object.assign(Object.assign({}, param), { type: renderableContentConverter([param.type]), description: renderableContentConverter(param.description) }))) });
-}
-function mapConstructor(constructor, renderableContentConverter, codeBlockConverter) {
-    var _a, _b;
-    return Object.assign(Object.assign(Object.assign({}, constructor), prepareDocumentable(constructor, renderableContentConverter, codeBlockConverter)), { parameters: (_a = constructor.parameters) === null || _a === void 0 ? void 0 : _a.map((param) => (Object.assign(Object.assign({}, param), { type: renderableContentConverter([param.type]), description: renderableContentConverter(param.description) }))), throws: (_b = constructor.throws) === null || _b === void 0 ? void 0 : _b.map((thrown) => (Object.assign(Object.assign({}, thrown), { type: renderableContentConverter([thrown.type]), description: renderableContentConverter(thrown.description) }))) });
-}
-function isEnumSource(source) {
-    return source.__type === 'enum';
-}
-function isInterfaceSource(source) {
-    return source.__type === 'interface';
-}
-//# sourceMappingURL=compile.js.map

package/lib/templating/compile.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compile.js","sourceRoot":"","sources":["../../src/templating/compile.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AAUpC,uCAA0D;AAC1D,qIAA6H;AAC7H,6GAAwG;AACxG,uHAAkH;AAClH,uGAAoG;AACpG,uHAAkH;AAOlH,SAAgB,OAAO,CAAC,QAAgB,EAAE,MAAkD,EAAE,OAAuB;IACnH,oBAAU,CAAC,eAAe,CAAC,iCAAiC,EAAE,sEAA+B,CAAC,CAAC;IAC/F,oBAAU,CAAC,eAAe,CAAC,6BAA6B,EAAE,2DAA2B,CAAC,CAAC;IACvF,oBAAU,CAAC,eAAe,CAAC,wBAAwB,EAAE,iDAAsB,CAAC,CAAC;IAC7E,oBAAU,CAAC,eAAe,CAAC,6BAA6B,EAAE,2DAA2B,CAAC,CAAC;IACvF,oBAAU,CAAC,eAAe,CAAC,uBAAuB,EAAE,6CAAqB,CAAC,CAAC;IAE3E,oBAAU,CAAC,cAAc,CAAC,oBAAoB,EAAE,4BAAkB,CAAC,CAAC;IAEpE,MAAM,QAAQ,mCAAQ,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,KAAE,SAAS,EAAE,IAAA,mBAAS,GAAE,GAAE,CAAC;IACzE,MAAM,QAAQ,GAAG,oBAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9C,OAAO,CACL,QAAQ,CAAC,QAAQ,CAAC;SACf,IAAI,EAAE;QACP,0BAA0B;SACzB,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAC9B,CAAC;AACJ,CAAC;AAjBD,0BAiBC;AAED,SAAS,OAAO,CACd,MAAkD,EAClD,EAAE,0BAA0B,EAAE,kBAAkB,EAAkB;IAElE,MAAM,IAAI,iDACL,MAAM,GACN,mBAAmB,CAAC,MAAM,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,GAC3E,eAAe,CAAC,MAAM,EAAE,0BAA0B,CAAC,CACvD,CAAC;IACF,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE;QACxB,uCACK,IAAI,GACJ,WAAW,CAAC,MAAM,EAAE,0BAA0B,CAAC,EAClD;KACH;SAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE;QACpC,uCACK,IAAI,GACJ,gBAAgB,CAAC,MAAM,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,EAC3E;KACH;SAAM;QACL,uCACK,IAAI,GACJ,YAAY,CAAC,MAAM,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,EACvE;KACH;AACH,CAAC;AAED,SAAS,mBAAmB,CAC1B,MAA0B,EAC1B,0BAA6D,EAC7D,kBAAiE;;IAEjE,OAAO;QACL,WAAW,EAAE,0BAA0B,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3D,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;QACnF,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;QAChF,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC3C,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,KAAK,EAAE,0BAA0B,CAAC,GAAG,CAAC,WAAW,CAAC;SACnD,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CACtB,MAAkD,EAClD,0BAA6D;;IAE7D,OAAO;QACL,IAAI,EAAE,MAAA,MAAM,CAAC,IAAI,0CAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACnE,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,MAAkB,EAAE,0BAA6D;IACpG,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACpC,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,WAAW,EAAE,0BAA0B,CAAC,KAAK,CAAC,WAAW,CAAC;SAC3D,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,MAAuB,EACvB,0BAA6D,EAC7D,kBAAiE;;IAEjE,OAAO;QACL,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,0CAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACxE,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,0CAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,CAAC;KAC5G,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,MAAmB,EACnB,0BAA6D,EAC7D,kBAAiE;;IAEjE,OAAO;QACL,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QAClF,YAAY,EAAE,MAAA,MAAM,CAAC,YAAY,0CAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CACrD,cAAc,CAAC,WAAW,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,CAC5E;QACD,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,0CAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,CAAC;QAC3G,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,0CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,+CACjC,KAAK,GACL,mBAAmB,CAAC,KAAK,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,KAC7E,IAAI,EAAE,0BAA0B,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAC9C,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAChB,MAAoB,EACpB,0BAAqE,EACrE,kBAAiE;;IAEjE,qDACK,MAAM,GACN,mBAAmB,CAAC,MAAM,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,KAC9E,UAAU,kCACL,MAAM,KACT,IAAI,EAAE,CAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,IAAI,EAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAChG,WAAW,EAAE,0BAA0B,CAAC,MAAA,MAAM,CAAC,UAAU,0CAAE,WAAW,CAAC,KAEzE,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,0CAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCAClC,MAAM,KACT,IAAI,EAAE,0BAA0B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAC/C,WAAW,EAAE,0BAA0B,CAAC,MAAM,CAAC,WAAW,CAAC,IAC3D,CAAC,EACH,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCACzC,KAAK,KACR,IAAI,EAAE,0BAA0B,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAC9C,WAAW,EAAE,0BAA0B,CAAC,KAAK,CAAC,WAAW,CAAC,IAC1D,CAAC,IACH;AACJ,CAAC;AAED,SAAS,cAAc,CACrB,WAAyB,EACzB,0BAAqE,EACrE,kBAAiE;;IAEjE,qDACK,WAAW,GACX,mBAAmB,CAAC,WAAW,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,KACnF,UAAU,EAAE,MAAA,WAAW,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCAC9C,KAAK,KACR,IAAI,EAAE,0BAA0B,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAC9C,WAAW,EAAE,0BAA0B,CAAC,KAAK,CAAC,WAAW,CAAC,IAC1D,CAAC,EACH,MAAM,EAAE,MAAA,WAAW,CAAC,MAAM,0CAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACvC,MAAM,KACT,IAAI,EAAE,0BAA0B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAC/C,WAAW,EAAE,0BAA0B,CAAC,MAAM,CAAC,WAAW,CAAC,IAC3D,CAAC,IACH;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,MAA0B;IAC9C,OAAO,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC;AAClC,CAAC;AAED,SAAS,iBAAiB,CAAC,MAA0B;IACnD,OAAO,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC;AACvC,CAAC"}

package/lib/templating/helpers.d.ts

@@ -1,2 +0,0 @@
-export declare const splitAndCapitalize: (text: string) => string;
-export declare const namespace: () => string | undefined;

package/lib/templating/helpers.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.namespace = exports.splitAndCapitalize = void 0;
-const settings_1 = require("../settings");
-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(' ');
-};
-exports.splitAndCapitalize = splitAndCapitalize;
-const namespace = () => {
-    return settings_1.Settings.getInstance().getNamespace();
-};
-exports.namespace = namespace;
-//# sourceMappingURL=helpers.js.map

package/lib/templating/helpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/templating/helpers.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AAEhC,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,EAAE;IACjD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KACrE;IACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC,CAAC;AAPW,QAAA,kBAAkB,sBAO7B;AAEK,MAAM,SAAS,GAAG,GAAG,EAAE;IAC5B,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,CAAC;AAC/C,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB"}

package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.d.ts

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

package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.typeLevelApexDocPartialTemplate = void 0;
-exports.typeLevelApexDocPartialTemplate = `
-{{#> documentablePartialTemplate}}
-
-{{#if group}}
-**Group** {{group}}
-{{/if}}
-
-{{#if author}}
-**Author** {{author}}
-{{/if}}
-
-{{#if date}}
-**Date** {{date}}
-{{/if}}
-
-{{#each sees}}
-**See** {{this}}
-
-{{/each}}
-
-{{#if namespace}}
-## Namespace
-{{namespace}}
-{{/if}}
-
-{{/documentablePartialTemplate}}
-`.trim();
-//# sourceMappingURL=type-level-apex-doc-partial-template.js.map

package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"type-level-apex-doc-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,+BAA+B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;CA0B9C,CAAC,IAAI,EAAE,CAAC"}