@cparra/apexdocs 2.8.0 → 2.9.0-alpha.0

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

@@ -0,0 +1,62 @@
+"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");
+class OpenApiDocsProcessor extends processor_type_transpiler_1.default {
+    constructor() {
+        super();
+        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');
+    }
+    fileBuilder() {
+        return this._fileContainer;
+    }
+    onProcess(type) {
+        var _a;
+        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;
+        const parser = new MethodParser_1.MethodParser(this.openApiModel);
+        // GET
+        parser.parseMethod(typeAsClass, endpointPath, 'get');
+        // PATCH
+        parser.parseMethod(typeAsClass, endpointPath, 'patch');
+        // POST
+        parser.parseMethod(typeAsClass, endpointPath, 'post');
+        // PUT
+        parser.parseMethod(typeAsClass, endpointPath, 'put');
+        // DELETE
+        parser.parseMethod(typeAsClass, endpointPath, 'delete');
+        this._fileContainer.pushFile(new openapi_type_file_1.OpenapiTypeFile(this.openApiModel));
+    }
+    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;
+        }
+        return urlMapping.value.replaceAll('"', '').replaceAll("'", '');
+    }
+}
+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;AAEtD,MAAa,oBAAqB,SAAQ,mCAAuB;IAI/D;QACE,KAAK,EAAE,CAAC;QACR,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,CAAC,CAAC;IAClD,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,MAAM,MAAM,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEnD,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;QAErD,QAAQ;QACR,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QAEvD,OAAO;QACP,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QAEtD,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;QAErD,SAAS;QACT,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;QAExD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,mCAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACvE,CAAC;IAEO,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,OAAO,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAlED,oDAkEC"}

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.referenceObject;
+        }
+        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,eAAe,CAAC;SACnC;QACD,OAAO,WAAW,CAAC,MAAM,CAAC;IAC5B,CAAC;CAKF;AA1BD,0BA0BC"}

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

@@ -0,0 +1,17 @@
+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): void;
+    private parseHttpAnnotation;
+    private addRequestBodyToOpenApi;
+    private addParametersToOpenApi;
+    private addHttpResponsesToOpenApi;
+    private addReference;
+}
+export {};

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

@@ -0,0 +1,104 @@
+"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 ParameterObjectBuilder_1 = require("./ParameterObjectBuilder");
+const ResponsesBuilder_1 = require("./ResponsesBuilder");
+const RequestBodyBuilder_1 = require("./RequestBodyBuilder");
+/**
+ * Parses ApexDocs with HTTP REST annotations and turns them into an OpenApi specification.
+ */
+class MethodParser {
+    constructor(openApiModel) {
+        this.openApiModel = openApiModel;
+    }
+    parseMethod(classMirror, httpUrlEndpoint, httpMethodKey) {
+        var _a;
+        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] = {};
+        if ((_a = httpMethod.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+            this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].description = httpMethod.docComment.description;
+        }
+        this.parseHttpAnnotation(httpMethod, httpUrlEndpoint, 'http-request-body', (inYaml, urlValue) => this.addRequestBodyToOpenApi(inYaml, urlValue, httpMethodKey));
+        this.parseHttpAnnotation(httpMethod, httpUrlEndpoint, 'http-parameter', (inYaml, urlValue) => this.addParametersToOpenApi(inYaml, urlValue, httpMethodKey));
+        this.parseHttpAnnotation(httpMethod, httpUrlEndpoint, 'http-response', (inYaml, urlValue) => this.addHttpResponsesToOpenApi(inYaml, urlValue, httpMethodKey));
+    }
+    parseHttpAnnotation(httpGetMethod, urlValue, annotationName, addToOpenApi) {
+        var _a;
+        const annotations = (_a = httpGetMethod.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((annotation) => annotation.name === annotationName);
+        if (!(annotations === null || annotations === void 0 ? void 0 : annotations.length)) {
+            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;
+            }
+            addToOpenApi(inYaml, urlValue);
+        }
+    }
+    addRequestBodyToOpenApi(inYaml, urlValue, httpMethodKey) {
+        // Convert the YAML into a JSON object.
+        const inJson = yaml.load(inYaml);
+        const requestBodyResponse = new RequestBodyBuilder_1.RequestBodyBuilder().build(inJson);
+        this.openApiModel.paths[urlValue][httpMethodKey].requestBody = requestBodyResponse.body;
+        if (requestBodyResponse.reference) {
+            // If a reference is returned, we want to make sure to add it to the OpenApi object as well
+            this.addReference(requestBodyResponse.reference);
+        }
+    }
+    addParametersToOpenApi(inYaml, urlValue, httpMethodKey) {
+        // Convert the YAML into a JSON object.
+        const inJson = yaml.load(inYaml);
+        const parameterObjectResponse = new ParameterObjectBuilder_1.ParameterObjectBuilder().build(inJson);
+        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);
+        if (parameterObjectResponse.reference) {
+            // If a reference is returned, we want to make sure to add it to the OpenApi object as well
+            this.addReference(parameterObjectResponse.reference);
+        }
+    }
+    addHttpResponsesToOpenApi(inYaml, urlValue, httpMethodKey) {
+        // Convert the YAML into a JSON object.
+        const inJson = yaml.load(inYaml);
+        const responseObjectResponse = new ResponsesBuilder_1.ResponsesBuilder().build(inJson);
+        if (this.openApiModel.paths[urlValue][httpMethodKey].responses === undefined) {
+            this.openApiModel.paths[urlValue][httpMethodKey].responses = {};
+        }
+        this.openApiModel.paths[urlValue][httpMethodKey].responses[inJson.statusCode] = responseObjectResponse.body;
+        // TODO: There's some duplication with the next 3 lines, because we do the same in all 3 places
+        if (responseObjectResponse.reference) {
+            // If a reference is returned, we want to make sure to add it to the OpenApi object as well
+            this.addReference(responseObjectResponse.reference);
+        }
+    }
+    addReference(reference) {
+        // Add to "component" section if it hasn't been already
+        if (this.openApiModel.components === undefined) {
+            this.openApiModel.components = {
+                schemas: {},
+            };
+        }
+        // Check if the referenced object is already part of the OpenApi object
+        if (this.openApiModel.components.schemas[reference.referencedClass]) {
+            return;
+        }
+        // If it isn't, then add it
+        this.openApiModel.components.schemas[reference.referencedClass] = reference.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;AAE1F,qEAAkE;AAClE,yDAAsD;AAMtD,6DAA0D;AAM1D;;GAEG;AACH,MAAa,YAAY;IACvB,YAAmB,YAAqB;QAArB,iBAAY,GAAZ,YAAY,CAAS;IAAG,CAAC;IAErC,WAAW,CAAC,WAAwB,EAAE,eAAuB,EAAE,aAA6B;;QACjG,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,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;QAED,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,eAAe,EAAE,mBAAmB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAC9F,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAC9D,CAAC;QACF,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,eAAe,EAAE,gBAAgB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAC3F,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAC7D,CAAC;QACF,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAC1F,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAChE,CAAC;IACJ,CAAC;IAEO,mBAAmB,CACzB,aAA2B,EAC3B,QAAgB,EAChB,cAAsB,EACtB,YAA0B;;QAE1B,MAAM,WAAW,GAAG,MAAA,aAAa,CAAC,UAAU,0CAAE,WAAW,CAAC,MAAM,CAC9D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,cAAc,CACnD,CAAC;QAEF,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAA,EAAE;YACxB,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,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;SAChC;IACH,CAAC;IAEO,uBAAuB,CAAC,MAAc,EAAE,QAAgB,EAAE,aAA6B;QAC7F,uCAAuC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAA2B,CAAC;QAC3D,MAAM,mBAAmB,GAAG,IAAI,uCAAkB,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnE,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAE,CAAC,WAAW,GAAG,mBAAmB,CAAC,IAAI,CAAC;QACzF,IAAI,mBAAmB,CAAC,SAAS,EAAE;YACjC,2FAA2F;YAC3F,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;SAClD;IACH,CAAC;IAEO,sBAAsB,CAAC,MAAc,EAAE,QAAgB,EAAE,aAA6B;QAC5F,uCAAuC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAA2B,CAAC;QAC3D,MAAM,uBAAuB,GAAG,IAAI,+CAAsB,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAE3E,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;QACjG,IAAI,uBAAuB,CAAC,SAAS,EAAE;YACrC,2FAA2F;YAC3F,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;SACtD;IACH,CAAC;IAEO,yBAAyB,CAAC,MAAc,EAAE,QAAgB,EAAE,aAA6B;QAC/F,uCAAuC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAwB,CAAC;QACxD,MAAM,sBAAsB,GAAG,IAAI,mCAAgB,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpE,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,MAAM,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC;QAC9G,+FAA+F;QAC/F,IAAI,sBAAsB,CAAC,SAAS,EAAE;YACpC,2FAA2F;YAC3F,IAAI,CAAC,YAAY,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;SACrD;IACH,CAAC;IAEO,YAAY,CAAC,SAAoB;QACvC,uDAAuD;QACvD,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,KAAK,SAAS,EAAE;YAC9C,IAAI,CAAC,YAAY,CAAC,UAAU,GAAG;gBAC7B,OAAO,EAAE,EAAE;aACZ,CAAC;SACH;QAED,uEAAuE;QACvE,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE;YACpE,OAAO;SACR;QAED,2BAA2B;QAC3B,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC;IACtF,CAAC;CACF;AAtHD,oCAsHC"}

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,16 @@
+import { ReferenceObject, SchemaObjectObject } from '../../../model/openapi/open-api-types';
+export declare class ReferenceBuilder {
+    build(referencedTypeName: string): Reference;
+    private getReferenceType;
+}
+/**
+ * In case where the Request Body contains a reference, this contains information about the handled reference
+ */
+export type Reference = {
+    /** Name of the class being referenced */
+    referencedClass: string;
+    /** OpenApi style reference object */
+    referenceObject: ReferenceObject;
+    /** Parsed representation of the referenced object as an OpenApi Schema object */
+    schema: SchemaObjectObject;
+};

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

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceBuilder = void 0;
+const types_repository_1 = require("../../../model/types-repository");
+// TODO: Unit tests
+class ReferenceBuilder {
+    build(referencedTypeName) {
+        // TODO: We also need to support inner classes
+        const referencedType = types_repository_1.TypesRepository.getInstance().getFromAllByName(referencedTypeName);
+        if (!referencedType) {
+            throw new Error(`The referenced class "${referencedTypeName}" was not found.`);
+        }
+        // Generate properties object from type
+        const properties = {};
+        // Filtering based on Salesforce's documentation: https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest_methods.htm#ApexRESTUserDefinedTypes
+        // Note that we assume that the class only contains object types allowed by Apex Rest:
+        // "Note that the public, private, or global class member variables must be types allowed by Apex REST"
+        const propertiesAndFields = [
+            ...referencedType.properties,
+            ...referencedType.fields,
+        ]
+            .filter((current) => !current.memberModifiers.includes('static'))
+            .filter((current) => !current.memberModifiers.includes('transient'));
+        propertiesAndFields.forEach((current) => {
+            properties[current.name] = {
+                type: this.getReferenceType(current.type),
+            };
+        });
+        return {
+            referencedClass: referencedTypeName,
+            referenceObject: {
+                $ref: `#/components/schemas/${referencedTypeName}`,
+            },
+            schema: {
+                type: 'object',
+                properties: properties,
+            },
+        };
+    }
+    getReferenceType(typeInMirror) {
+        // TODO: Better support for list and maps, instead of it just returning object
+        // Returns a valid type supported by OpenApi from a received Apex type.
+        typeInMirror = typeInMirror.toLowerCase();
+        switch (typeInMirror) {
+            case 'boolean':
+                return 'boolean';
+            case 'decimal':
+                return 'number';
+            case 'double':
+                return 'number';
+            case 'id':
+                return 'string';
+            case 'integer':
+                return 'integer';
+            case 'long':
+                return 'number';
+            case 'string':
+                return 'string';
+            default:
+                return 'object';
+        }
+    }
+}
+exports.ReferenceBuilder = ReferenceBuilder;
+//# sourceMappingURL=ReferenceBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ReferenceBuilder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/ReferenceBuilder.ts"],"names":[],"mappings":";;;AACA,sEAAkE;AAGlE,mBAAmB;AACnB,MAAa,gBAAgB;IAC3B,KAAK,CAAC,kBAA0B;QAC9B,8CAA8C;QAC9C,MAAM,cAAc,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;QAC1F,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,yBAAyB,kBAAkB,kBAAkB,CAAC,CAAC;SAChF;QAED,uCAAuC;QACvC,MAAM,UAAU,GAAqB,EAAE,CAAC;QAExC,yKAAyK;QACzK,sFAAsF;QACtF,uGAAuG;QACvG,MAAM,mBAAmB,GAAG;YAC1B,GAAI,cAA8B,CAAC,UAAU;YAC7C,GAAI,cAA8B,CAAC,MAAM;SAC1C;aACE,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;aAChE,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QAEvE,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACtC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG;gBACzB,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC;aAC1C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,eAAe,EAAE,kBAAkB;YACnC,eAAe,EAAE;gBACf,IAAI,EAAE,wBAAwB,kBAAkB,EAAE;aACnD;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,UAAU;aACvB;SACF,CAAC;IACJ,CAAC;IAEO,gBAAgB,CAAC,YAAoB;QAC3C,8EAA8E;QAC9E,uEAAuE;QACvE,YAAY,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC;QAC1C,QAAQ,YAAY,EAAE;YACpB,KAAK,SAAS;gBACZ,OAAO,SAAS,CAAC;YACnB,KAAK,SAAS;gBACZ,OAAO,QAAQ,CAAC;YAClB,KAAK,QAAQ;gBACX,OAAO,QAAQ,CAAC;YAClB,KAAK,IAAI;gBACP,OAAO,QAAQ,CAAC;YAClB,KAAK,SAAS;gBACZ,OAAO,SAAS,CAAC;YACnB,KAAK,MAAM;gBACT,OAAO,QAAQ,CAAC;YAClB,KAAK,QAAQ;gBACX,OAAO,QAAQ,CAAC;YAClB;gBACE,OAAO,QAAQ,CAAC;SACnB;IACH,CAAC;CACF;AA9DD,4CA8DC"}

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

@@ -0,0 +1,10 @@
+import { RequestBody } from '../../../model/openapi/open-api-types';
+import { Reference } from './ReferenceBuilder';
+import { ApexDocHttpRequestBody } from '../../../model/openapi/apex-doc-types';
+import { Builder } from './Builder';
+/**
+ * Parses and builds OpenApi Request Body objects.
+ */
+export declare class RequestBodyBuilder extends Builder<RequestBody, ApexDocHttpRequestBody> {
+    buildBody(apexRequestBody: ApexDocHttpRequestBody, reference?: Reference): RequestBody;
+}

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestBodyBuilder = void 0;
+const Builder_1 = require("./Builder");
+/**
+ * Parses and builds OpenApi Request Body objects.
+ */
+class RequestBodyBuilder extends Builder_1.Builder {
+    buildBody(apexRequestBody, reference) {
+        return {
+            description: apexRequestBody.description,
+            content: {
+                'application/json': { schema: this.getOpenApiSchemaFromApexDocSchema(apexRequestBody, reference) },
+            },
+            required: apexRequestBody.required,
+        };
+    }
+}
+exports.RequestBodyBuilder = RequestBodyBuilder;
+//# sourceMappingURL=RequestBodyBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RequestBodyBuilder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/RequestBodyBuilder.ts"],"names":[],"mappings":";;;AAGA,uCAAoC;AAEpC;;GAEG;AACH,MAAa,kBAAmB,SAAQ,iBAA4C;IAClF,SAAS,CAAC,eAAuC,EAAE,SAAqB;QACtE,OAAO;YACL,WAAW,EAAE,eAAe,CAAC,WAAW;YACxC,OAAO,EAAE;gBACP,kBAAkB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,iCAAiC,CAAC,eAAe,EAAE,SAAS,CAAC,EAAE;aACnG;YACD,QAAQ,EAAE,eAAe,CAAC,QAAQ;SACnC,CAAC;IACJ,CAAC;CACF;AAVD,gDAUC"}

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

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

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponsesBuilder = void 0;
+const Builder_1 = require("./Builder");
+class ResponsesBuilder extends Builder_1.Builder {
+    buildBody(apexDocResponseDefinition, reference) {
+        return {
+            description: `Status code ${apexDocResponseDefinition.statusCode}`,
+            content: {
+                'application/json': {
+                    schema: this.getOpenApiSchemaFromApexDocSchema(apexDocResponseDefinition, reference),
+                },
+            },
+        };
+    }
+}
+exports.ResponsesBuilder = ResponsesBuilder;
+//# sourceMappingURL=ResponsesBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ResponsesBuilder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/ResponsesBuilder.ts"],"names":[],"mappings":";;;AAGA,uCAAoC;AAEpC,MAAa,gBAAiB,SAAQ,iBAA4C;IAChF,SAAS,CAAC,yBAA8C,EAAE,SAAqB;QAC7E,OAAO;YACL,WAAW,EAAE,eAAe,yBAAyB,CAAC,UAAU,EAAE;YAClE,OAAO,EAAE;gBACP,kBAAkB,EAAE;oBAClB,MAAM,EAAE,IAAI,CAAC,iCAAiC,CAAC,yBAAyB,EAAE,SAAS,CAAC;iBACrF;aACF;SACF,CAAC;IACJ,CAAC;CACF;AAXD,4CAWC"}

package/lib/transpiler/processor-type-transpiler.d.ts

@@ -1,10 +1,10 @@
 import { Type } from '@cparra/apex-reflection';
 import { FileContainer } from './file-container';
-export declare type LinkingStrategy = 'root-relative' | 'path-relative';
+export type LinkingStrategy = 'root-relative' | 'path-relative';
 export default abstract class ProcessorTypeTranspiler {
     onBeforeProcess: ((types: Type[]) => void) | undefined;
     abstract onProcess(type: Type): void;
     onAfterProcess: ((types: Type[]) => void) | undefined;
     abstract fileBuilder(): FileContainer;
-    abstract getLinkingStrategy(): LinkingStrategy;
+    getLinkingStrategy(): LinkingStrategy;
 }

package/lib/transpiler/processor-type-transpiler.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class ProcessorTypeTranspiler {
+    getLinkingStrategy() {
+        return 'root-relative';
+    }
 }
 exports.default = ProcessorTypeTranspiler;
 //# sourceMappingURL=processor-type-transpiler.js.map

package/lib/transpiler/processor-type-transpiler.js.map

@@ -1 +1 @@
-{"version":3,"file":"processor-type-transpiler.js","sourceRoot":"","sources":["../../src/transpiler/processor-type-transpiler.ts"],"names":[],"mappings":";;AAKA,MAA8B,uBAAuB;CAUpD;AAVD,0CAUC"}
+{"version":3,"file":"processor-type-transpiler.js","sourceRoot":"","sources":["../../src/transpiler/processor-type-transpiler.ts"],"names":[],"mappings":";;AAKA,MAA8B,uBAAuB;IASnD,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AAZD,0CAYC"}

package/lib/transpiler/transpiler.js.map

@@ -1 +1 @@
-{"version":3,"file":"transpiler.js","sourceRoot":"","sources":["../../src/transpiler/transpiler.ts"],"names":[],"mappings":";;AAEA,0CAAuC;AACvC,4CAAqC;AAErC,MAAqB,UAAU;IAC7B,MAAM,CAAC,QAAQ,CAAC,KAAa,EAAE,SAAkC;;QAC/D,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;YACtD,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC,CAAC;YAC/C,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,MAAA,SAAS,CAAC,eAAe,+CAAzB,SAAS,EAAmB,WAAW,EAAE;QAEzC,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,KAAK,IAAI,EAAE;YAC7C,OAAO;SACR;QAED,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAClC,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;YACvD,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,MAAA,SAAS,CAAC,cAAc,+CAAxB,SAAS,EAAkB,WAAW,EAAE;IAC1C,CAAC;CACF;AApBD,6BAoBC"}
+{"version":3,"file":"transpiler.js","sourceRoot":"","sources":["../../src/transpiler/transpiler.ts"],"names":[],"mappings":";;AAEA,0CAAuC;AACvC,4CAAqC;AAErC,MAAqB,UAAU;IAC7B,MAAM,CAAC,QAAQ,CAAC,KAAa,EAAE,SAAkC;;QAC/D,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;YACtD,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC,CAAC;YAC/C,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,MAAA,SAAS,CAAC,eAAe,0DAAG,WAAW,CAAC,CAAC;QAEzC,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,KAAK,IAAI,EAAE;YAC7C,OAAO;SACR;QAED,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAClC,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;YACvD,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,MAAA,SAAS,CAAC,cAAc,0DAAG,WAAW,CAAC,CAAC;IAC1C,CAAC;CACF;AApBD,6BAoBC"}

package/lib/util/error-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"error-logger.js","sourceRoot":"","sources":["../../src/util/error-logger.ts"],"names":[],"mappings":";;AACA,qCAAkC;AAElC,MAAqB,WAAW;IACvB,MAAM,CAAC,SAAS,CAAC,KAAa;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5B,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,WAAiB,EAAE,UAAiB;QACxE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAEhC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;YACrC,IAAI,CAAC,iBAAiB,CAAC,WAA0B,CAAC,CAAC;SACpD;aAAM,IAAI,WAAW,CAAC,SAAS,KAAK,WAAW,EAAE;YAChD,IAAI,CAAC,qBAAqB,CAAC,WAA8B,CAAC,CAAC;SAC5D;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,WAAiB,EAAE,UAAiB;;QAC/D,UAAI,WAAW,CAAC,UAAU,0CAAE,KAAK,EAAE;YACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;YAC3F,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,2CAA2C,CAAC,CAAC;YACrE,eAAM,CAAC,KAAK,CAAC,cAAc,WAAW,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;YACpE,eAAM,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC3C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,WAAwB,EAAE,UAAiB;QAC1E,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QAC3F,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,kBAAkB,EAAE,EAAE;;YACtD,UAAI,kBAAkB,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACxC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,kDAAkD,CAAC,CAAC;gBAC5E,eAAM,CAAC,KAAK,CAAC,cAAc,kBAAkB,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBAC3E,eAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClD,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;;YAC1C,UAAI,YAAY,CAAC,UAAU,0CAAE,KAAK,EAAE;gBAClC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,4CAA4C,CAAC,CAAC;gBACtE,eAAM,CAAC,KAAK,CAAC,cAAc,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACrE,eAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC5C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;;YACjD,UAAI,eAAe,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACrC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,+CAA+C,CAAC,CAAC;gBACzE,eAAM,CAAC,KAAK,CAAC,cAAc,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACxE,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC/C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAC5C,UAAI,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,6CAA6C,CAAC,CAAC;gBACvE,eAAM,CAAC,KAAK,CAAC,cAAc,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACtE,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC7C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACxC,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE;YAClD,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC3C,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,eAAgC;QACnE,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAChD,UAAI,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,eAAM,CAAC,KAAK,CAAC,GAAG,eAAe,CAAC,IAAI,6CAA6C,CAAC,CAAC;gBACnF,eAAM,CAAC,KAAK,CAAC,YAAY,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACpE,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC7C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,8BAwFC"}
+{"version":3,"file":"error-logger.js","sourceRoot":"","sources":["../../src/util/error-logger.ts"],"names":[],"mappings":";;AACA,qCAAkC;AAElC,MAAqB,WAAW;IACvB,MAAM,CAAC,SAAS,CAAC,KAAa;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5B,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,WAAiB,EAAE,UAAiB;QACxE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAEhC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;YACrC,IAAI,CAAC,iBAAiB,CAAC,WAA0B,CAAC,CAAC;SACpD;aAAM,IAAI,WAAW,CAAC,SAAS,KAAK,WAAW,EAAE;YAChD,IAAI,CAAC,qBAAqB,CAAC,WAA8B,CAAC,CAAC;SAC5D;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,WAAiB,EAAE,UAAiB;;QAC/D,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,KAAK,EAAE;YACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;YAC3F,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,2CAA2C,CAAC,CAAC;YACrE,eAAM,CAAC,KAAK,CAAC,cAAc,WAAW,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;YACpE,eAAM,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC3C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,WAAwB,EAAE,UAAiB;QAC1E,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QAC3F,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,kBAAkB,EAAE,EAAE;;YACtD,IAAI,MAAA,kBAAkB,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACxC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,kDAAkD,CAAC,CAAC;gBAC5E,eAAM,CAAC,KAAK,CAAC,cAAc,kBAAkB,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBAC3E,eAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClD,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;;YAC1C,IAAI,MAAA,YAAY,CAAC,UAAU,0CAAE,KAAK,EAAE;gBAClC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,4CAA4C,CAAC,CAAC;gBACtE,eAAM,CAAC,KAAK,CAAC,cAAc,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACrE,eAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC5C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;;YACjD,IAAI,MAAA,eAAe,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACrC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,+CAA+C,CAAC,CAAC;gBACzE,eAAM,CAAC,KAAK,CAAC,cAAc,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACxE,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC/C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAC5C,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,6CAA6C,CAAC,CAAC;gBACvE,eAAM,CAAC,KAAK,CAAC,cAAc,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACtE,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC7C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACxC,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE;YAClD,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC3C,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,eAAgC;QACnE,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAChD,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,eAAM,CAAC,KAAK,CAAC,GAAG,eAAe,CAAC,IAAI,6CAA6C,CAAC,CAAC;gBACnF,eAAM,CAAC,KAAK,CAAC,YAAY,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACpE,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC7C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,8BAwFC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.8.0",
+  "version": "2.9.0-alpha.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -25,6 +25,7 @@
     "docs:init": "docsify init docs",
     "docs:serve": "docsify serve docs",
     "execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private protected -g docsify --defaultGroupName \"Misc Group\"",
+    "execute:example:openapi": "node lib/cli/generate.js -s examples/force-app -t docs protected -g openapi --openApiTitle \"My REST Api 2\"",
     "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly"
   },
   "author": "Cesar Parra",
@@ -39,8 +40,8 @@
     "@types/node": "^13.7.4",
     "@types/shelljs": "^0.8.6",
     "@types/yargs": "^15.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.1.0",
-    "@typescript-eslint/parser": "^5.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
     "docsify": "^4.12.2",
     "eslint": "^8.0.1",
     "eslint-config-prettier": "^8.3.0",
@@ -51,7 +52,7 @@
     "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.1.3",
-    "typescript": "^3.8.2"
+    "typescript": "^4.8.4"
   },
   "husky": {
     "hooks": {
@@ -64,9 +65,11 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "1.7.0",
+    "@cparra/apex-reflection": "1.10.3",
+    "@types/js-yaml": "^4.0.5",
     "chalk": "^4.1.2",
     "fast-xml-parser": "^4.0.1",
+    "js-yaml": "^4.1.0",
     "log-update": "4.0.0",
     "xss": "^1.0.11",
     "yargs": "^16.0.3"

package/src/application/Apexdocs.ts

@@ -7,9 +7,11 @@ import { RawBodyParser } from '../service/parser';
 import { Settings } from '../settings';
 import Transpiler from '../transpiler/transpiler';
 import { FileWriter } from '../service/file-writer';
-import { TypesRepository } from '../model/types-repository';
 import ErrorLogger from '../util/error-logger';
 import ApexBundle from '../model/apex-bundle';
+import Manifest from '../model/manifest';
+import { TypesRepository } from '../model/types-repository';
+import { TypeTranspilerFactory } from '../transpiler/factory';
 
 /**
  * Application entry-point to generate documentation out of Apex source files.
@@ -22,21 +24,10 @@ export class Apexdocs {
     Logger.log('Initializing...');
     const fileBodies = ApexFileReader.processFiles(new DefaultFileSystem());
     const manifest = createManifest(new RawBodyParser(fileBodies), this._reflectionWithLogger);
-
-    const filteredTypes: Type[] = manifest.filteredByAccessModifierAndAnnotations(Settings.getInstance().scope);
-    TypesRepository.getInstance().populate(filteredTypes);
-    Logger.clear();
-
-    Logger.logSingle(
-      `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${
-        Settings.getInstance().scope
-      }`,
-      false,
-      'green',
-      false,
-    );
-    Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
-    const processor = Settings.getInstance().typeTranspiler;
+    TypesRepository.getInstance().populateAll(manifest.types);
+    const filteredTypes = this.filterByScopes(manifest);
+    TypesRepository.getInstance().populateScoped(filteredTypes);
+    const processor = TypeTranspilerFactory.get(Settings.getInstance().targetGenerator);
     Transpiler.generate(filteredTypes, processor);
     const generatedFiles = processor.fileBuilder().files();
     FileWriter.write(generatedFiles, (fileName: string) => {
@@ -47,6 +38,36 @@ export class Apexdocs {
     ErrorLogger.logErrors(filteredTypes);
   }
 
+  private static filterByScopes(manifest: Manifest) {
+    let filteredTypes: Type[];
+    let filteredLogMessage;
+    if (Settings.getInstance().config.targetGenerator !== 'openapi') {
+      filteredTypes = manifest.filteredByAccessModifierAndAnnotations(Settings.getInstance().scope);
+      filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${
+        Settings.getInstance().scope
+      }`;
+    } else {
+      // If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
+      // we only keep classes annotated as @RestResource
+      filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
+        'restresource',
+        'httpdelete',
+        'httpget',
+        'httppatch',
+        'httppost',
+        'httpput',
+      ]);
+      filteredLogMessage = `Filtered ${
+        manifest.types.length - filteredTypes.length
+      } file(s), only keeping classes annotated as @RestResource.`;
+    }
+    Logger.clear();
+
+    Logger.logSingle(filteredLogMessage, false, 'green', false);
+    Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
+    return filteredTypes;
+  }
+
   static _reflectionWithLogger = (apexBundle: ApexBundle): ReflectionResult => {
     const result = reflect(apexBundle.rawTypeContent);
     if (result.error) {