@cparra/apexdocs 2.25.0-alpha.9 → 2.25.0

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

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownTranspilerBase = void 0;
+const processor_type_transpiler_1 = 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

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;AAAA,4EAAmE;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/plain-docsProcessor.d.ts

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

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

@@ -0,0 +1,14 @@
+"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;
+//# sourceMappingURL=plain-docsProcessor.js.map

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

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

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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,75 @@
+"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;
+//# sourceMappingURL=open-api-docs-processor.js.map

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

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

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

@@ -0,0 +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;
+}

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

@@ -0,0 +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;
+//# sourceMappingURL=Builder.js.map

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

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

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

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

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

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodParser = void 0;
+const yaml = require("js-yaml");
+const ClassMirrorWrapper_1 = require("../../../model/apex-type-wrappers/ClassMirrorWrapper");
+const ReferenceBuilder_1 = require("./ReferenceBuilder");
+const ParameterObjectBuilder_1 = require("./ParameterObjectBuilder");
+const ResponsesBuilder_1 = require("./ResponsesBuilder");
+const RequestBodyBuilder_1 = require("./RequestBodyBuilder");
+const MethodMirrorWrapper_1 = require("../../../model/apex-type-wrappers/MethodMirrorWrapper");
+/**
+ * Parses ApexDocs with HTTP REST annotations and turns them into an OpenApi specification.
+ */
+class MethodParser {
+    constructor(openApiModel) {
+        this.openApiModel = openApiModel;
+    }
+    parseMethod(classMirror, httpUrlEndpoint, httpMethodKey, tag) {
+        var _a, _b;
+        const classMirrorWrapper = new ClassMirrorWrapper_1.ClassMirrorWrapper(classMirror);
+        // Apex supports HttpGet, HttpPut, HttpPost, HttpDelete, and HttpPatch, so we search for a method
+        // that has one of those annotations.
+        const httpMethods = classMirrorWrapper.getMethodsByAnnotation(`http${httpMethodKey}`);
+        if (!httpMethods.length) {
+            return;
+        }
+        // We can assume there is at most one method per annotation, as this is an Apex rule.
+        const httpMethod = httpMethods[0];
+        this.openApiModel.paths[httpUrlEndpoint][httpMethodKey] = {};
+        this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].tags = [tag];
+        if ((_a = httpMethod.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+            this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].description = httpMethod.docComment.description;
+        }
+        const methodMirrorWrapper = new MethodMirrorWrapper_1.MethodMirrorWrapper(httpMethod);
+        if (methodMirrorWrapper.hasDocCommentAnnotation('summary')) {
+            this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].summary =
+                (_b = methodMirrorWrapper.getDocCommentAnnotation('summary')) === null || _b === void 0 ? void 0 : _b.body;
+        }
+        this.parseHttpAnnotation(httpMethod, httpUrlEndpoint, httpMethodKey, 'http-request-body', this.addRequestBodyToOpenApi.bind(this), this.fallbackHttpRequestBodyParser(httpUrlEndpoint, httpMethodKey));
+        this.parseHttpAnnotation(httpMethod, httpUrlEndpoint, httpMethodKey, 'http-parameter', this.addParametersToOpenApi.bind(this));
+        this.parseHttpAnnotation(httpMethod, httpUrlEndpoint, httpMethodKey, 'http-response', this.addHttpResponsesToOpenApi.bind(this), this.getFallbackHttpResponseParser(httpUrlEndpoint, httpMethodKey));
+    }
+    parseHttpAnnotation(httpMethod, urlValue, httpMethodKey, annotationName, addToOpenApi, fallbackParser) {
+        var _a;
+        const annotations = (_a = httpMethod.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((annotation) => annotation.name === annotationName);
+        if (!(annotations === null || annotations === void 0 ? void 0 : annotations.length)) {
+            if (fallbackParser) {
+                fallbackParser(httpMethod);
+            }
+            return;
+        }
+        for (const annotation of annotations) {
+            // We expect the ApexDoc data representing this to be in YAML format.
+            const inYaml = annotation === null || annotation === void 0 ? void 0 : annotation.bodyLines.reduce((prev, current, _) => prev + '\n' + current);
+            if (!inYaml) {
+                return;
+            }
+            this.addToOpenApiStrategy(inYaml, urlValue, httpMethodKey, addToOpenApi);
+        }
+    }
+    addToOpenApiStrategy(inYaml, urlValue, httpMethodKey, addToOpenApi) {
+        // Convert the YAML into a JSON object.
+        const inJson = yaml.load(inYaml);
+        const requestBodyResponse = new RequestBodyBuilder_1.RequestBodyBuilder().build(inJson);
+        addToOpenApi(inJson, urlValue, httpMethodKey);
+        this.addReference(requestBodyResponse);
+    }
+    addRequestBodyToOpenApi(input, urlValue, httpMethodKey) {
+        const requestBodyResponse = new RequestBodyBuilder_1.RequestBodyBuilder().build(input);
+        this.openApiModel.paths[urlValue][httpMethodKey].requestBody = requestBodyResponse.body;
+    }
+    addParametersToOpenApi(input, urlValue, httpMethodKey) {
+        const parameterObjectResponse = new ParameterObjectBuilder_1.ParameterObjectBuilder().build(input);
+        if (this.openApiModel.paths[urlValue][httpMethodKey].parameters === undefined) {
+            // If no parameters have been defined yet, initialize the list.
+            this.openApiModel.paths[urlValue][httpMethodKey].parameters = [];
+        }
+        this.openApiModel.paths[urlValue][httpMethodKey].parameters.push(parameterObjectResponse.body);
+    }
+    addHttpResponsesToOpenApi(input, urlValue, httpMethodKey) {
+        const responseObjectResponse = new ResponsesBuilder_1.ResponsesBuilder().build(input);
+        if (this.openApiModel.paths[urlValue][httpMethodKey].responses === undefined) {
+            this.openApiModel.paths[urlValue][httpMethodKey].responses = {};
+        }
+        this.openApiModel.paths[urlValue][httpMethodKey].responses[input.statusCode] = responseObjectResponse.body;
+    }
+    fallbackHttpRequestBodyParser(httpUrlEndpoint, httpMethodKey) {
+        return (methodMirror) => {
+            // If the Apex method receives parameters, they will be interpreted by Salesforce as a JSON
+            // object, with each key of the object being the parameter name.
+            const parameters = methodMirror.parameters;
+            if (!parameters.length) {
+                return;
+            }
+            const propertiesObject = {};
+            parameters.forEach((currentParameter) => {
+                const propertyKey = currentParameter.name;
+                const propertyReference = new ReferenceBuilder_1.ReferenceBuilder().getReferenceType(currentParameter.typeReference);
+                propertiesObject[propertyKey] = propertyReference.schema;
+                this.addReference({
+                    reference: {
+                        entrypointReferenceObject: propertyReference.schema,
+                        referenceComponents: propertyReference.referenceComponents,
+                    },
+                });
+            });
+            this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].requestBody = {
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: propertiesObject,
+                        },
+                    },
+                },
+            };
+        };
+    }
+    getFallbackHttpResponseParser(httpUrlEndpoint, httpMethodKey) {
+        return (methodMirror) => {
+            var _a, _b;
+            // Parses methods that return an object (as opposed to void).
+            const returnType = methodMirror.typeReference;
+            if (returnType.type.toLowerCase() === 'void') {
+                return;
+            }
+            const reference = new ReferenceBuilder_1.ReferenceBuilder().getReferenceType(returnType);
+            this.addReference({
+                reference: {
+                    entrypointReferenceObject: reference.schema,
+                    referenceComponents: reference.referenceComponents,
+                },
+            });
+            if (this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses === undefined) {
+                this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses = {};
+            }
+            // Successful responses with a non-void return type always return a status code of 2000
+            this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses['200'] = {
+                description: (_b = (_a = methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.description) !== null && _b !== void 0 ? _b : 'Status code 200',
+                content: {
+                    'application/json': { schema: reference.schema },
+                },
+            };
+        };
+    }
+    addReference(referenceHolder) {
+        if (referenceHolder.reference) {
+            // If a reference is returned, we want to make sure to add it to the OpenApi object as well
+            // Add to "component" section if it hasn't been already
+            if (this.openApiModel.components === undefined) {
+                this.openApiModel.components = {
+                    schemas: {},
+                };
+            }
+            if (!referenceHolder.reference.referenceComponents.length) {
+                return;
+            }
+            // Add all received references to the OpenApi components section.
+            referenceHolder.reference.referenceComponents.forEach((current) => {
+                // Check if the referenced object is already part of the OpenApi object
+                this.openApiModel.components.schemas[current.referencedClass] = current.schema;
+            });
+        }
+    }
+}
+exports.MethodParser = MethodParser;
+//# sourceMappingURL=MethodParser.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MethodParser.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/MethodParser.ts"],"names":[],"mappings":";;;AAEA,gCAAgC;AAChC,6FAA0F;AAC1F,yDAAiE;AACjE,qEAAkE;AAClE,yDAAsD;AAMtD,6DAA0D;AAG1D,+FAA4F;AAO5F;;GAEG;AACH,MAAa,YAAY;IACvB,YAAmB,YAAqB;QAArB,iBAAY,GAAZ,YAAY,CAAS;IAAG,CAAC;IAErC,WAAW,CAAC,WAAwB,EAAE,eAAuB,EAAE,aAA6B,EAAE,GAAW;;QAC9G,MAAM,kBAAkB,GAAG,IAAI,uCAAkB,CAAC,WAAW,CAAC,CAAC;QAC/D,iGAAiG;QACjG,qCAAqC;QACrC,MAAM,WAAW,GAAG,kBAAkB,CAAC,sBAAsB,CAAC,OAAO,aAAa,EAAE,CAAC,CAAC;QACtF,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACvB,OAAO;SACR;QAED,qFAAqF;QACrF,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAElC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;QAC7D,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,aAAa,CAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACtE,IAAI,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,EAAE;YACtC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,aAAa,CAAE,CAAC,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC;SAC1G;QACD,MAAM,mBAAmB,GAAG,IAAI,yCAAmB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,mBAAmB,CAAC,uBAAuB,CAAC,SAAS,CAAC,EAAE;YAC1D,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,aAAa,CAAE,CAAC,OAAO;gBAC9D,MAAA,mBAAmB,CAAC,uBAAuB,CAAC,SAAS,CAAC,0CAAE,IAAI,CAAC;SAChE;QAED,IAAI,CAAC,mBAAmB,CACtB,UAAU,EACV,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EACvC,IAAI,CAAC,6BAA6B,CAAC,eAAe,EAAE,aAAa,CAAC,CACnE,CAAC;QAEF,IAAI,CAAC,mBAAmB,CACtB,UAAU,EACV,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;QAEF,IAAI,CAAC,mBAAmB,CACtB,UAAU,EACV,eAAe,EACf,aAAa,EACb,eAAe,EACf,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,EACzC,IAAI,CAAC,6BAA6B,CAAC,eAAe,EAAE,aAAa,CAAC,CACnE,CAAC;IACJ,CAAC;IAEO,mBAAmB,CACzB,UAAwB,EACxB,QAAgB,EAChB,aAA6B,EAC7B,cAAsB,EACtB,YAA6B,EAC7B,cAAqC;;QAErC,MAAM,WAAW,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;QAElH,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAA,EAAE;YACxB,IAAI,cAAc,EAAE;gBAClB,cAAc,CAAC,UAAU,CAAC,CAAC;aAC5B;YACD,OAAO;SACR;QAED,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,qEAAqE;YACrE,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC;YAEzF,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO;aACR;YAED,IAAI,CAAC,oBAAoB,CAAI,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;SAC7E;IACH,CAAC;IAEO,oBAAoB,CAC1B,MAAc,EACd,QAAgB,EAChB,aAA6B,EAC7B,YAA6B;QAE7B,uCAAuC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAM,CAAC;QACtC,MAAM,mBAAmB,GAAG,IAAI,uCAAkB,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnE,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;QAE9C,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACzC,CAAC;IAEO,uBAAuB,CAC7B,KAA6B,EAC7B,QAAgB,EAChB,aAA6B;QAE7B,MAAM,mBAAmB,GAAG,IAAI,uCAAkB,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClE,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAE,CAAC,WAAW,GAAG,mBAAmB,CAAC,IAAI,CAAC;IAC3F,CAAC;IAEO,sBAAsB,CAAC,KAA6B,EAAE,QAAgB,EAAE,aAA6B;QAC3G,MAAM,uBAAuB,GAAG,IAAI,+CAAsB,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAE1E,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAE,CAAC,UAAU,KAAK,SAAS,EAAE;YAC9E,+DAA+D;YAC/D,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAE,CAAC,UAAU,GAAG,EAAE,CAAC;SACnE;QACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAE,CAAC,UAAW,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IACnG,CAAC;IAEO,yBAAyB,CAAC,KAA0B,EAAE,QAAgB,EAAE,aAA6B;QAC3G,MAAM,sBAAsB,GAAG,IAAI,mCAAgB,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEnE,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAE,CAAC,SAAS,KAAK,SAAS,EAAE;YAC7E,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAE,CAAC,SAAS,GAAG,EAAE,CAAC;SAClE;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAE,CAAC,SAAU,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC;IAC/G,CAAC;IAEO,6BAA6B,CACnC,eAAuB,EACvB,aAA0D;QAE1D,OAAO,CAAC,YAA0B,EAAE,EAAE;YACpC,2FAA2F;YAC3F,gEAAgE;YAChE,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;YAE3C,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;gBACtB,OAAO;aACR;YAED,MAAM,gBAAgB,GAAqB,EAAE,CAAC;YAC9C,UAAU,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE;gBACtC,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC;gBAC1C,MAAM,iBAAiB,GAAG,IAAI,mCAAgB,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;gBAElG,gBAAgB,CAAC,WAAW,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAEzD,IAAI,CAAC,YAAY,CAAC;oBAChB,SAAS,EAAE;wBACT,yBAAyB,EAAE,iBAAiB,CAAC,MAAyB;wBACtE,mBAAmB,EAAE,iBAAiB,CAAC,mBAAmB;qBAC3D;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,aAAa,CAAE,CAAC,WAAW,GAAG;gBACrE,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE,gBAAgB;yBAC7B;qBACF;iBACF;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAEO,6BAA6B,CACnC,eAAuB,EACvB,aAA0D;QAE1D,OAAO,CAAC,YAA0B,EAAE,EAAE;;YACpC,6DAA6D;YAC7D,MAAM,UAAU,GAAG,YAAY,CAAC,aAAa,CAAC;YAE9C,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE;gBAC5C,OAAO;aACR;YAED,MAAM,SAAS,GAAG,IAAI,mCAAgB,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAEtE,IAAI,CAAC,YAAY,CAAC;gBAChB,SAAS,EAAE;oBACT,yBAAyB,EAAE,SAAS,CAAC,MAAyB;oBAC9D,mBAAmB,EAAE,SAAS,CAAC,mBAAmB;iBACnD;aACF,CAAC,CAAC;YAEH,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,aAAa,CAAE,CAAC,SAAS,KAAK,SAAS,EAAE;gBACpF,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,aAAa,CAAE,CAAC,SAAS,GAAG,EAAE,CAAC;aACzE;YAED,uFAAuF;YACvF,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,aAAa,CAAE,CAAC,SAAU,CAAC,KAAK,CAAC,GAAG;gBAC3E,WAAW,EAAE,MAAA,MAAA,YAAY,CAAC,UAAU,0CAAE,WAAW,mCAAI,iBAAiB;gBACtE,OAAO,EAAE;oBACP,kBAAkB,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE;iBACjD;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAEO,YAAY,CAAC,eAA0C;QAC7D,IAAI,eAAe,CAAC,SAAS,EAAE;YAC7B,2FAA2F;YAC3F,uDAAuD;YACvD,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,KAAK,SAAS,EAAE;gBAC9C,IAAI,CAAC,YAAY,CAAC,UAAU,GAAG;oBAC7B,OAAO,EAAE,EAAE;iBACZ,CAAC;aACH;YAED,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE;gBACzD,OAAO;aACR;YAED,iEAAiE;YACjE,eAAe,CAAC,SAAS,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAChE,uEAAuE;gBACvE,IAAI,CAAC,YAAY,CAAC,UAAW,CAAC,OAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;YACnF,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;CACF;AA/ND,oCA+NC"}

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

@@ -0,0 +1,7 @@
+import { ParameterObject } from '../../../model/openapi/open-api-types';
+import { Reference } from './ReferenceBuilder';
+import { ApexDocParameterObject } from '../../../model/openapi/apex-doc-types';
+import { Builder } from './Builder';
+export declare class ParameterObjectBuilder extends Builder<ParameterObject, ApexDocParameterObject> {
+    buildBody(apexDocObject: ApexDocParameterObject, reference?: Reference): ParameterObject;
+}

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParameterObjectBuilder = void 0;
+const Builder_1 = require("./Builder");
+class ParameterObjectBuilder extends Builder_1.Builder {
+    buildBody(apexDocObject, reference) {
+        return Object.assign(Object.assign({}, apexDocObject), { schema: this.getOpenApiSchemaFromApexDocSchema(apexDocObject, reference) });
+    }
+}
+exports.ParameterObjectBuilder = ParameterObjectBuilder;
+//# sourceMappingURL=ParameterObjectBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ParameterObjectBuilder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/ParameterObjectBuilder.ts"],"names":[],"mappings":";;;AAGA,uCAAoC;AAEpC,MAAa,sBAAuB,SAAQ,iBAAgD;IAC1F,SAAS,CAAC,aAAqC,EAAE,SAAqB;QACpE,uCACK,aAAa,KAChB,MAAM,EAAE,IAAI,CAAC,iCAAiC,CAAC,aAAa,EAAE,SAAS,CAAC,IACxE;IACJ,CAAC;CACF;AAPD,wDAOC"}

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

@@ -0,0 +1,39 @@
+import { ReferenceObject, SchemaObject, SchemaObjectArray, SchemaObjectObject } from '../../../model/openapi/open-api-types';
+import { ReferencedType } from '@cparra/apex-reflection';
+export declare class ReferenceBuilder {
+    build(referencedTypeName: string): Reference;
+    /**
+     * Returns a tuple where the first value is the name of the reference without any collection related values
+     * and the second is a boolean representing if we are dealing with a collection or not.
+     * @param referencedTypeName The received raw type name.
+     * @private
+     */
+    private handlePossibleCollectionReference;
+    private buildReferenceFromType;
+    private handleOverriddenSchema;
+    private getReferenceName;
+    private buildMainReferenceComponent;
+    getReferenceType(typeInMirror: ReferencedType): SchemaObjectReferencePair;
+    private buildCollectionPair;
+    private isReferenceString;
+}
+type SchemaObjectReferencePair = {
+    schema: SchemaObject;
+    referenceComponents: ReferenceComponent[];
+};
+/**
+ * In case where the Request Body contains a reference, this contains information about the handled reference
+ */
+export type Reference = {
+    /** OpenApi style reference object for the parent caller */
+    entrypointReferenceObject: ReferenceObject;
+    /** List of objects that contain all component references identified by a call to this builder **/
+    referenceComponents: ReferenceComponent[];
+};
+export type ReferenceComponent = {
+    /** Name of the class being referenced */
+    referencedClass: string;
+    /** Parsed representation of the referenced object as an OpenApi Schema object */
+    schema: SchemaObjectObject | SchemaObjectArray;
+};
+export {};