@cparra/apexdocs 2.24.0 → 2.25.0-alpha.0

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

@@ -0,0 +1,49 @@
+"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

@@ -0,0 +1 @@
+{"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,6 +1,13 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
-export declare class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
-    homeFileName(): string;
-    getLinkingStrategy(): LinkingStrategy;
-}
+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,14 +1,122 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlainMarkdownDocsProcessor = void 0;
-const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
-class PlainMarkdownDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
-    homeFileName() {
-        return 'index';
-    }
-    getLinkingStrategy() {
-        return 'path-relative';
-    }
-}
-exports.PlainMarkdownDocsProcessor = PlainMarkdownDocsProcessor;
+"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 +1 @@
-{"version":3,"file":"plain-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAGrE,MAAa,0BAA2B,SAAQ,iDAAsB;IACpE,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,gEAQC"}
+{"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"}

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

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

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

@@ -0,0 +1,31 @@
+"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

@@ -0,0 +1 @@
+{"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"}

package/lib/transpiler/openapi/open-api-docs-processor.d.ts

@@ -1,13 +1,13 @@
-import ProcessorTypeTranspiler from '../processor-type-transpiler';
-import { FileContainer } from '../file-container';
-import { Type } from '@cparra/apex-reflection';
-import { OpenApi } from '../../model/openapi/open-api';
-export declare class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
-    protected readonly _fileContainer: FileContainer;
-    openApiModel: OpenApi;
-    constructor();
-    fileBuilder(): FileContainer;
-    onProcess(type: Type): void;
-    onAfterProcess: ((types: Type[]) => void) | undefined;
-    private getEndpointPath;
-}
+import ProcessorTypeTranspiler from '../processor-type-transpiler';
+import { FileContainer } from '../file-container';
+import { Type } from '@cparra/apex-reflection';
+import { OpenApi } from '../../model/openapi/open-api';
+export declare class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
+    protected readonly _fileContainer: FileContainer;
+    openApiModel: OpenApi;
+    constructor();
+    fileBuilder(): FileContainer;
+    onProcess(type: Type): void;
+    onAfterProcess: ((types: Type[]) => void) | undefined;
+    private getEndpointPath;
+}

package/lib/transpiler/openapi/open-api-docs-processor.js

@@ -1,75 +1,78 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenApiDocsProcessor = void 0;
-const processor_type_transpiler_1 = require("../processor-type-transpiler");
-const file_container_1 = require("../file-container");
-const openapi_type_file_1 = require("../../model/openapi/openapi-type-file");
-const logger_1 = require("../../util/logger");
-const open_api_1 = require("../../model/openapi/open-api");
-const settings_1 = require("../../settings");
-const MethodParser_1 = require("./parsers/MethodParser");
-const string_utils_1 = require("../../util/string-utils");
-class OpenApiDocsProcessor extends processor_type_transpiler_1.default {
-    constructor() {
-        super();
-        this.onAfterProcess = () => {
-            this._fileContainer.pushFile(new openapi_type_file_1.OpenapiTypeFile(this.openApiModel));
-        };
-        this._fileContainer = new file_container_1.FileContainer();
-        const title = settings_1.Settings.getInstance().getOpenApiTitle();
-        if (!title) {
-            throw Error('No OpenApi title was provided.');
-        }
-        this.openApiModel = new open_api_1.OpenApi(title, '1.0.0', settings_1.Settings.getInstance().getNamespace());
-    }
-    fileBuilder() {
-        return this._fileContainer;
-    }
-    onProcess(type) {
-        var _a, _b;
-        logger_1.Logger.logSingle(`Processing ${type.name}`, false, 'green', false);
-        const endpointPath = this.getEndpointPath(type);
-        if (!endpointPath) {
-            return;
-        }
-        this.openApiModel.paths[endpointPath] = {};
-        if ((_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description) {
-            this.openApiModel.paths[endpointPath].description = type.docComment.description;
-        }
-        // We can safely cast to a ClassMirror, since only these support the @RestResource annotation
-        const typeAsClass = type;
-        // Add tags for this Apex class to the OpenApi model
-        const tagName = (0, string_utils_1.camel2title)(endpointPath);
-        this.openApiModel.tags.push({
-            name: tagName,
-            description: (_b = type.docComment) === null || _b === void 0 ? void 0 : _b.description,
-        });
-        const parser = new MethodParser_1.MethodParser(this.openApiModel);
-        // GET
-        parser.parseMethod(typeAsClass, endpointPath, 'get', tagName);
-        // PATCH
-        parser.parseMethod(typeAsClass, endpointPath, 'patch', tagName);
-        // POST
-        parser.parseMethod(typeAsClass, endpointPath, 'post', tagName);
-        // PUT
-        parser.parseMethod(typeAsClass, endpointPath, 'put', tagName);
-        // DELETE
-        parser.parseMethod(typeAsClass, endpointPath, 'delete', tagName);
-    }
-    getEndpointPath(type) {
-        var _a;
-        const restResourceAnnotation = type.annotations.find((element) => element.name.toLowerCase() === 'restresource');
-        const urlMapping = (_a = restResourceAnnotation === null || restResourceAnnotation === void 0 ? void 0 : restResourceAnnotation.elementValues) === null || _a === void 0 ? void 0 : _a.find((element) => element.key.toLowerCase() === 'urlmapping');
-        if (!urlMapping) {
-            logger_1.Logger.error(`Type does not contain urlMapping annotation ${type.name}`);
-            return null;
-        }
-        let endpointPath = urlMapping.value.replaceAll('"', '').replaceAll("'", '').replaceAll('/*', '/');
-        if (endpointPath.startsWith('/')) {
-            endpointPath = endpointPath.substring(1);
-        }
-        return endpointPath;
-    }
-}
-exports.OpenApiDocsProcessor = OpenApiDocsProcessor;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiDocsProcessor = void 0;
+const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
+const file_container_1 = require("../file-container");
+const openapi_type_file_1 = require("../../model/openapi/openapi-type-file");
+const logger_1 = require("../../util/logger");
+const open_api_1 = require("../../model/openapi/open-api");
+const settings_1 = require("../../settings");
+const MethodParser_1 = require("./parsers/MethodParser");
+const string_utils_1 = require("../../util/string-utils");
+class OpenApiDocsProcessor extends processor_type_transpiler_1.default {
+    constructor() {
+        super();
+        this.onAfterProcess = () => {
+            this._fileContainer.pushFile(new openapi_type_file_1.OpenapiTypeFile(this.openApiModel));
+        };
+        this._fileContainer = new file_container_1.FileContainer();
+        const title = settings_1.Settings.getInstance().getOpenApiTitle();
+        if (!title) {
+            throw Error('No OpenApi title was provided.');
+        }
+        this.openApiModel = new open_api_1.OpenApi(title, '1.0.0', settings_1.Settings.getInstance().getNamespace());
+    }
+    fileBuilder() {
+        return this._fileContainer;
+    }
+    onProcess(type) {
+        var _a, _b;
+        logger_1.Logger.logSingle(`Processing ${type.name}`, false, 'green', false);
+        const endpointPath = this.getEndpointPath(type);
+        if (!endpointPath) {
+            return;
+        }
+        this.openApiModel.paths[endpointPath] = {};
+        if ((_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+            this.openApiModel.paths[endpointPath].description = type.docComment.description;
+        }
+        // We can safely cast to a ClassMirror, since only these support the @RestResource annotation
+        const typeAsClass = type;
+        // Add tags for this Apex class to the OpenApi model
+        const tagName = (0, string_utils_1.camel2title)(endpointPath);
+        this.openApiModel.tags.push({
+            name: tagName,
+            description: (_b = type.docComment) === null || _b === void 0 ? void 0 : _b.description,
+        });
+        const parser = new MethodParser_1.MethodParser(this.openApiModel);
+        // GET
+        parser.parseMethod(typeAsClass, endpointPath, 'get', tagName);
+        // PATCH
+        parser.parseMethod(typeAsClass, endpointPath, 'patch', tagName);
+        // POST
+        parser.parseMethod(typeAsClass, endpointPath, 'post', tagName);
+        // PUT
+        parser.parseMethod(typeAsClass, endpointPath, 'put', tagName);
+        // DELETE
+        parser.parseMethod(typeAsClass, endpointPath, 'delete', tagName);
+    }
+    getEndpointPath(type) {
+        var _a;
+        const restResourceAnnotation = type.annotations.find((element) => element.name.toLowerCase() === 'restresource');
+        const urlMapping = (_a = restResourceAnnotation === null || restResourceAnnotation === void 0 ? void 0 : restResourceAnnotation.elementValues) === null || _a === void 0 ? void 0 : _a.find((element) => element.key.toLowerCase() === 'urlmapping');
+        if (!urlMapping) {
+            logger_1.Logger.error(`Type does not contain urlMapping annotation ${type.name}`);
+            return null;
+        }
+        let endpointPath = urlMapping.value.replaceAll('"', '').replaceAll("'", '').replaceAll('/*', '/');
+        if (endpointPath.startsWith('/')) {
+            endpointPath = endpointPath.substring(1);
+        }
+        return endpointPath;
+    }
+}
+exports.OpenApiDocsProcessor = OpenApiDocsProcessor;
 //# sourceMappingURL=open-api-docs-processor.js.map

package/lib/transpiler/openapi/open-api-docs-processor.js.map

@@ -1 +1 @@
-{"version":3,"file":"open-api-docs-processor.js","sourceRoot":"","sources":["../../../src/transpiler/openapi/open-api-docs-processor.ts"],"names":[],"mappings":";;;AAAA,4EAAmE;AACnE,sDAAkD;AAElD,6EAAwE;AACxE,8CAA2C;AAC3C,2DAAuD;AACvD,6CAA0C;AAC1C,yDAAsD;AACtD,0DAAsD;AAEtD,MAAa,oBAAqB,SAAQ,mCAAuB;IAI/D;QACE,KAAK,EAAE,CAAC;QAsDV,mBAAc,GAA0C,GAAG,EAAE;YAC3D,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,mCAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC;QAvDA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,CAAC;QACvD,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,KAAK,CAAC,gCAAgC,CAAC,CAAC;SAC/C;QACD,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAO,CAAC,KAAK,EAAE,OAAO,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,SAAS,CAAC,IAAU;;QAClB,eAAM,CAAC,SAAS,CAAC,cAAc,IAAI,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAEnE,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO;SACR;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QAC3C,IAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,EAAE;YAChC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SACjF;QAED,6FAA6F;QAC7F,MAAM,WAAW,GAAG,IAAmB,CAAC;QAExC,oDAAoD;QACpD,MAAM,OAAO,GAAG,IAAA,0BAAW,EAAC,YAAY,CAAC,CAAC;QAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEnD,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9D,QAAQ;QACR,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEhE,OAAO;QACP,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/D,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9D,SAAS;QACT,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAMO,eAAe,CAAC,IAAU;;QAChC,MAAM,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QACjH,MAAM,UAAU,GAAG,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,aAAa,0CAAE,IAAI,CAC5D,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,YAAY,CACxD,CAAC;QACF,IAAI,CAAC,UAAU,EAAE;YACf,eAAM,CAAC,KAAK,CAAC,+CAA+C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC;SACb;QAED,IAAI,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAClG,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAChC,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAC1C;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AA/ED,oDA+EC"}
+{"version":3,"file":"open-api-docs-processor.js","sourceRoot":"","sources":["../../../src/transpiler/openapi/open-api-docs-processor.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AACnE,sDAAkD;AAElD,6EAAwE;AACxE,8CAA2C;AAC3C,2DAAuD;AACvD,6CAA0C;AAC1C,yDAAsD;AACtD,0DAAsD;AAEtD,MAAa,oBAAqB,SAAQ,mCAAuB;IAI/D;QACE,KAAK,EAAE,CAAC;QAsDV,mBAAc,GAA0C,GAAG,EAAE;YAC3D,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,mCAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC;QAvDA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,CAAC;QACvD,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,KAAK,CAAC,gCAAgC,CAAC,CAAC;SAC/C;QACD,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAO,CAAC,KAAK,EAAE,OAAO,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,SAAS,CAAC,IAAU;;QAClB,eAAM,CAAC,SAAS,CAAC,cAAc,IAAI,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAEnE,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO;SACR;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QAC3C,IAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,EAAE;YAChC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SACjF;QAED,6FAA6F;QAC7F,MAAM,WAAW,GAAG,IAAmB,CAAC;QAExC,oDAAoD;QACpD,MAAM,OAAO,GAAG,IAAA,0BAAW,EAAC,YAAY,CAAC,CAAC;QAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEnD,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9D,QAAQ;QACR,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEhE,OAAO;QACP,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/D,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9D,SAAS;QACT,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAMO,eAAe,CAAC,IAAU;;QAChC,MAAM,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QACjH,MAAM,UAAU,GAAG,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,aAAa,0CAAE,IAAI,CAC5D,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,YAAY,CACxD,CAAC;QACF,IAAI,CAAC,UAAU,EAAE;YACf,eAAM,CAAC,KAAK,CAAC,+CAA+C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC;SACb;QAED,IAAI,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAClG,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAChC,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAC1C;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AA/ED,oDA+EC"}

package/lib/transpiler/openapi/parsers/Builder.d.ts

@@ -1,16 +1,16 @@
-import { Reference } from './ReferenceBuilder';
-import { ApexDocSchemaObject } from '../../../model/openapi/apex-doc-types';
-import { SchemaObject } from '../../../model/openapi/open-api-types';
-export type ApexDocSchemaAware = {
-    schema: ApexDocSchemaObject;
-};
-export declare abstract class Builder<T, K> {
-    build(schemaAware: ApexDocSchemaAware): Response<T>;
-    abstract buildBody(apexDocObject: K, reference?: Reference): T;
-    protected getOpenApiSchemaFromApexDocSchema(schemaAware: ApexDocSchemaAware, reference?: Reference): SchemaObject;
-    private isReferenceString;
-}
-export interface Response<T> {
-    reference?: Reference;
-    body: T;
-}
+import { Reference } from './ReferenceBuilder';
+import { ApexDocSchemaObject } from '../../../model/openapi/apex-doc-types';
+import { SchemaObject } from '../../../model/openapi/open-api-types';
+export type ApexDocSchemaAware = {
+    schema: ApexDocSchemaObject;
+};
+export declare abstract class Builder<T, K> {
+    build(schemaAware: ApexDocSchemaAware): Response<T>;
+    abstract buildBody(apexDocObject: K, reference?: Reference): T;
+    protected getOpenApiSchemaFromApexDocSchema(schemaAware: ApexDocSchemaAware, reference?: Reference): SchemaObject;
+    private isReferenceString;
+}
+export interface Response<T> {
+    reference?: Reference;
+    body: T;
+}

package/lib/transpiler/openapi/parsers/Builder.js

@@ -1,30 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Builder = void 0;
-const ReferenceBuilder_1 = require("./ReferenceBuilder");
-class Builder {
-    constructor() {
-        this.isReferenceString = (targetObject) => {
-            return typeof targetObject === 'string' || targetObject instanceof String;
-        };
-    }
-    build(schemaAware) {
-        let reference;
-        if (this.isReferenceString(schemaAware.schema)) {
-            reference = new ReferenceBuilder_1.ReferenceBuilder().build(schemaAware.schema);
-        }
-        return {
-            reference: reference,
-            body: this.buildBody(schemaAware, reference),
-        };
-    }
-    getOpenApiSchemaFromApexDocSchema(schemaAware, reference) {
-        if (this.isReferenceString(schemaAware.schema)) {
-            // We are dealing with a reference
-            return reference.entrypointReferenceObject;
-        }
-        return schemaAware.schema;
-    }
-}
-exports.Builder = Builder;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Builder = void 0;
+const ReferenceBuilder_1 = require("./ReferenceBuilder");
+class Builder {
+    constructor() {
+        this.isReferenceString = (targetObject) => {
+            return typeof targetObject === 'string' || targetObject instanceof String;
+        };
+    }
+    build(schemaAware) {
+        let reference;
+        if (this.isReferenceString(schemaAware.schema)) {
+            reference = new ReferenceBuilder_1.ReferenceBuilder().build(schemaAware.schema);
+        }
+        return {
+            reference: reference,
+            body: this.buildBody(schemaAware, reference),
+        };
+    }
+    getOpenApiSchemaFromApexDocSchema(schemaAware, reference) {
+        if (this.isReferenceString(schemaAware.schema)) {
+            // We are dealing with a reference
+            return reference.entrypointReferenceObject;
+        }
+        return schemaAware.schema;
+    }
+}
+exports.Builder = Builder;
 //# sourceMappingURL=Builder.js.map

package/lib/transpiler/openapi/parsers/Builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"Builder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/Builder.ts"],"names":[],"mappings":";;;AAAA,yDAAiE;AAQjE,MAAsB,OAAO;IAA7B;QAuBU,sBAAiB,GAAG,CAAC,YAAiB,EAA0B,EAAE;YACxE,OAAO,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,YAAY,MAAM,CAAC;QAC5E,CAAC,CAAC;IACJ,CAAC;IAzBC,KAAK,CAAC,WAA+B;QACnC,IAAI,SAAgC,CAAC;QACrC,IAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;YAC9C,SAAS,GAAG,IAAI,mCAAgB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;SAC9D;QAED,OAAO;YACL,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAgB,EAAE,SAAS,CAAC;SAClD,CAAC;IACJ,CAAC;IAIS,iCAAiC,CAAC,WAA+B,EAAE,SAAqB;QAChG,IAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;YAC9C,kCAAkC;YAClC,OAAO,SAAU,CAAC,yBAAyB,CAAC;SAC7C;QACD,OAAO,WAAW,CAAC,MAAM,CAAC;IAC5B,CAAC;CAKF;AA1BD,0BA0BC"}
+{"version":3,"file":"Builder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/Builder.ts"],"names":[],"mappings":";;;AAAA,yDAAiE;AAQjE,MAAsB,OAAO;IAA7B;QAuBU,sBAAiB,GAAG,CAAC,YAAqB,EAA0B,EAAE;YAC5E,OAAO,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,YAAY,MAAM,CAAC;QAC5E,CAAC,CAAC;IACJ,CAAC;IAzBC,KAAK,CAAC,WAA+B;QACnC,IAAI,SAAgC,CAAC;QACrC,IAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;YAC9C,SAAS,GAAG,IAAI,mCAAgB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;SAC9D;QAED,OAAO;YACL,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAgB,EAAE,SAAS,CAAC;SAClD,CAAC;IACJ,CAAC;IAIS,iCAAiC,CAAC,WAA+B,EAAE,SAAqB;QAChG,IAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;YAC9C,kCAAkC;YAClC,OAAO,SAAU,CAAC,yBAAyB,CAAC;SAC7C;QACD,OAAO,WAAW,CAAC,MAAM,CAAC;IAC5B,CAAC;CAKF;AA1BD,0BA0BC"}

package/lib/transpiler/openapi/parsers/MethodParser.d.ts

@@ -1,20 +1,20 @@
-import { ClassMirror } from '@cparra/apex-reflection';
-import { OpenApi } from '../../../model/openapi/open-api';
-type HttpOperations = 'get' | 'put' | 'post' | 'delete' | 'patch';
-/**
- * Parses ApexDocs with HTTP REST annotations and turns them into an OpenApi specification.
- */
-export declare class MethodParser {
-    openApiModel: OpenApi;
-    constructor(openApiModel: OpenApi);
-    parseMethod(classMirror: ClassMirror, httpUrlEndpoint: string, httpMethodKey: HttpOperations, tag: string): void;
-    private parseHttpAnnotation;
-    private addToOpenApiStrategy;
-    private addRequestBodyToOpenApi;
-    private addParametersToOpenApi;
-    private addHttpResponsesToOpenApi;
-    private fallbackHttpRequestBodyParser;
-    private getFallbackHttpResponseParser;
-    private addReference;
-}
-export {};
+import { ClassMirror } from '@cparra/apex-reflection';
+import { OpenApi } from '../../../model/openapi/open-api';
+type HttpOperations = 'get' | 'put' | 'post' | 'delete' | 'patch';
+/**
+ * Parses ApexDocs with HTTP REST annotations and turns them into an OpenApi specification.
+ */
+export declare class MethodParser {
+    openApiModel: OpenApi;
+    constructor(openApiModel: OpenApi);
+    parseMethod(classMirror: ClassMirror, httpUrlEndpoint: string, httpMethodKey: HttpOperations, tag: string): void;
+    private parseHttpAnnotation;
+    private addToOpenApiStrategy;
+    private addRequestBodyToOpenApi;
+    private addParametersToOpenApi;
+    private addHttpResponsesToOpenApi;
+    private fallbackHttpRequestBodyParser;
+    private getFallbackHttpResponseParser;
+    private addReference;
+}
+export {};