@cparra/apexdocs 2.8.2 → 2.9.0-alpha.1

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

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceBuilder = void 0;
+const types_repository_1 = require("../../../model/types-repository");
+class ReferenceBuilder {
+    build(referencedTypeName) {
+        const [parsedReferencedType, isCollection] = this.handlePossibleCollectionReference(referencedTypeName);
+        const referencedTypeBundle = types_repository_1.TypesRepository.getInstance().getFromAllByName(parsedReferencedType);
+        if (!referencedTypeBundle) {
+            throw new Error(`The referenced type "${parsedReferencedType}" was not found.`);
+        }
+        if (referencedTypeBundle.type.type_name !== 'class') {
+            throw new Error(`Expected the referenced type to be a class, but found a ${referencedTypeBundle.type.type_name}.`);
+        }
+        const typeBundleWithIsCollection = Object.assign(Object.assign({}, referencedTypeBundle), { isCollection: isCollection });
+        return this.buildReferenceFromType(typeBundleWithIsCollection);
+    }
+    /**
+     * 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
+     */
+    handlePossibleCollectionReference(referencedTypeName) {
+        referencedTypeName = referencedTypeName.toLowerCase();
+        if (referencedTypeName.startsWith('list<') && referencedTypeName.endsWith('>')) {
+            referencedTypeName = referencedTypeName.replace('list<', '');
+            referencedTypeName = referencedTypeName.replace('>', '');
+            return [referencedTypeName, true];
+        }
+        if (referencedTypeName.startsWith('set<') && referencedTypeName.endsWith('>')) {
+            referencedTypeName = referencedTypeName.replace('set<', '');
+            referencedTypeName = referencedTypeName.replace('>', '');
+            return [referencedTypeName, true];
+        }
+        return [referencedTypeName, false];
+    }
+    buildReferenceFromType(typeBundle) {
+        // Filtering based on Salesforce's documentation:
+        // https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest_methods.htm#ApexRESTUserDefinedTypes
+        // 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 = [
+            ...typeBundle.type.properties,
+            ...typeBundle.type.fields,
+        ]
+            .filter((current) => !current.memberModifiers.includes('static'))
+            .filter((current) => !current.memberModifiers.includes('transient'));
+        const properties = {};
+        let referencedComponents = [];
+        propertiesAndFields.forEach((current) => {
+            var _a;
+            const pair = this.getReferenceType(current.typeReference);
+            properties[current.name] = pair.schema;
+            properties[current.name].description = (_a = current.docComment) === null || _a === void 0 ? void 0 : _a.description;
+            pair.referenceComponents.forEach((current) => referencedComponents.push(current));
+        });
+        const mainReferenceComponents = this.buildMainReferenceComponent(typeBundle, properties);
+        // Make sure to add the "main" reference first
+        referencedComponents = [...mainReferenceComponents, ...referencedComponents];
+        return {
+            entrypointReferenceObject: {
+                $ref: `#/components/schemas/${this.getReferenceName(typeBundle)}`,
+            },
+            referenceComponents: referencedComponents,
+        };
+    }
+    getReferenceName(typeBundle) {
+        var _a;
+        let referenceName = typeBundle.type.name;
+        if (typeBundle.isChild) {
+            referenceName = `${(_a = typeBundle.parentType) === null || _a === void 0 ? void 0 : _a.name}.${typeBundle.type.name}`;
+        }
+        if (typeBundle.isCollection) {
+            referenceName = `${referenceName}_array`;
+        }
+        return referenceName;
+    }
+    buildMainReferenceComponent(typeBundle, properties) {
+        // For the main reference, we always want to get the reference of the object without the collection part,
+        // so we pass the typeBundle to `getReferenceName` but with the isCollection flag set to false.
+        const mainReferenceName = this.getReferenceName(Object.assign(Object.assign({}, typeBundle), { isCollection: false }));
+        const mainReference = {
+            referencedClass: mainReferenceName,
+            schema: {
+                type: 'object',
+                properties: properties,
+            },
+        };
+        const referencedComponents = [mainReference];
+        if (!typeBundle.isCollection) {
+            return referencedComponents;
+        }
+        return [
+            {
+                referencedClass: this.getReferenceName(typeBundle),
+                schema: {
+                    type: 'array',
+                    items: {
+                        $ref: `#/components/schemas/${mainReferenceName}`,
+                    },
+                },
+            },
+            ...referencedComponents,
+        ];
+    }
+    getReferenceType(typeInMirror) {
+        // Returns a valid type supported by OpenApi from a received Apex type.
+        const typeName = typeInMirror.type.toLowerCase();
+        switch (typeName) {
+            case 'boolean':
+                return { schema: { type: 'boolean' }, referenceComponents: [] };
+            case 'date':
+                return { schema: { type: 'string', format: 'date' }, referenceComponents: [] };
+            case 'datetime':
+                return { schema: { type: 'string', format: 'date-time' }, referenceComponents: [] };
+            case 'decimal':
+                return { schema: { type: 'number' }, referenceComponents: [] };
+            case 'double':
+                return { schema: { type: 'number' }, referenceComponents: [] };
+            case 'id':
+                return { schema: { type: 'string' }, referenceComponents: [] };
+            case 'integer':
+                return { schema: { type: 'integer' }, referenceComponents: [] };
+            case 'long':
+                return { schema: { type: 'integer', format: 'int64' }, referenceComponents: [] };
+            case 'string':
+                return { schema: { type: 'string' }, referenceComponents: [] };
+            case 'time':
+                return { schema: { type: 'string', format: 'time' }, referenceComponents: [] };
+            case 'list':
+                return this.buildCollectionPair(typeInMirror);
+            case 'set':
+                return this.buildCollectionPair(typeInMirror);
+            case 'map':
+                // For Maps, we treat them as objects but do not try to define their shape, because their keys can vary
+                // at runtime.
+                return { schema: { type: 'object' }, referenceComponents: [] };
+            default:
+                // If we got here we are dealing with a non-primitive (most likely a custom class or an SObject).
+                const referencedType = types_repository_1.TypesRepository.getInstance().getFromAllByName(typeName);
+                if (!referencedType) {
+                    return { schema: { type: 'object' }, referenceComponents: [] };
+                }
+                const reference = this.buildReferenceFromType(Object.assign(Object.assign({}, referencedType), { isCollection: false }));
+                return {
+                    schema: reference.entrypointReferenceObject,
+                    referenceComponents: [...reference.referenceComponents],
+                };
+        }
+    }
+    buildCollectionPair(typeInMirror) {
+        const innerReference = this.getReferenceType(typeInMirror.ofType);
+        return {
+            schema: { type: 'array', items: innerReference.schema },
+            referenceComponents: [...innerReference.referenceComponents],
+        };
+    }
+}
+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":";;;AAOA,sEAA8E;AAM9E,MAAa,gBAAgB;IAC3B,KAAK,CAAC,kBAA0B;QAC9B,MAAM,CAAC,oBAAoB,EAAE,YAAY,CAAC,GAAG,IAAI,CAAC,iCAAiC,CAAC,kBAAkB,CAAC,CAAC;QACxG,MAAM,oBAAoB,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;QAElG,IAAI,CAAC,oBAAoB,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,wBAAwB,oBAAoB,kBAAkB,CAAC,CAAC;SACjF;QACD,IAAI,oBAAoB,CAAC,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE;YACnD,MAAM,IAAI,KAAK,CACb,2DAA2D,oBAAoB,CAAC,IAAI,CAAC,SAAS,GAAG,CAClG,CAAC;SACH;QACD,MAAM,0BAA0B,mCAAQ,oBAAoB,KAAE,YAAY,EAAE,YAAY,GAAE,CAAC;QAC3F,OAAO,IAAI,CAAC,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACK,iCAAiC,CAAC,kBAA0B;QAClE,kBAAkB,GAAG,kBAAkB,CAAC,WAAW,EAAE,CAAC;QACtD,IAAI,kBAAkB,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9E,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC7D,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACzD,OAAO,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;SACnC;QACD,IAAI,kBAAkB,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC7E,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC5D,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACzD,OAAO,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;SACnC;QACD,OAAO,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAEO,sBAAsB,CAAC,UAAsC;QACnE,iDAAiD;QACjD,0HAA0H;QAC1H,4EAA4E;QAC5E,uGAAuG;QACvG,MAAM,mBAAmB,GAAqC;YAC5D,GAAI,UAAU,CAAC,IAAoB,CAAC,UAAU;YAC9C,GAAI,UAAU,CAAC,IAAoB,CAAC,MAAM;SAC3C;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,MAAM,UAAU,GAAqB,EAAE,CAAC;QACxC,IAAI,oBAAoB,GAAyB,EAAE,CAAC;QACpD,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;;YACtC,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAC1D,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;YACvC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,GAAG,MAAA,OAAO,CAAC,UAAU,0CAAE,WAAW,CAAC;YACvE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;QAEH,MAAM,uBAAuB,GAAG,IAAI,CAAC,2BAA2B,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEzF,8CAA8C;QAC9C,oBAAoB,GAAG,CAAC,GAAG,uBAAuB,EAAE,GAAG,oBAAoB,CAAC,CAAC;QAE7E,OAAO;YACL,yBAAyB,EAAE;gBACzB,IAAI,EAAE,wBAAwB,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;aAClE;YACD,mBAAmB,EAAE,oBAAoB;SAC1C,CAAC;IACJ,CAAC;IAEO,gBAAgB,CAAC,UAAsC;;QAC7D,IAAI,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;QACzC,IAAI,UAAU,CAAC,OAAO,EAAE;YACtB,aAAa,GAAG,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1E;QACD,IAAI,UAAU,CAAC,YAAY,EAAE;YAC3B,aAAa,GAAG,GAAG,aAAa,QAAQ,CAAC;SAC1C;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAEO,2BAA2B,CACjC,UAAsC,EACtC,UAA4B;QAE5B,yGAAyG;QACzG,+FAA+F;QAC/F,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,iCAAM,UAAU,KAAE,YAAY,EAAE,KAAK,IAAG,CAAC;QACxF,MAAM,aAAa,GAAuB;YACxC,eAAe,EAAE,iBAAiB;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,UAAU;aACvB;SACF,CAAC;QACF,MAAM,oBAAoB,GAAG,CAAC,aAAa,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE;YAC5B,OAAO,oBAAoB,CAAC;SAC7B;QAED,OAAO;YACL;gBACE,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC;gBAClD,MAAM,EAAE;oBACN,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,wBAAwB,iBAAiB,EAAE;qBAClD;iBACF;aACF;YACD,GAAG,oBAAoB;SACxB,CAAC;IACJ,CAAC;IAEO,gBAAgB,CAAC,YAA4B;QACnD,uEAAuE;QACvE,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjD,QAAQ,QAAQ,EAAE;YAChB,KAAK,SAAS;gBACZ,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YAClE,KAAK,MAAM;gBACT,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACjF,KAAK,UAAU;gBACb,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACtF,KAAK,SAAS;gBACZ,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACjE,KAAK,QAAQ;gBACX,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACjE,KAAK,IAAI;gBACP,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACjE,KAAK,SAAS;gBACZ,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YAClE,KAAK,MAAM;gBACT,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACnF,KAAK,QAAQ;gBACX,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACjE,KAAK,MAAM;gBACT,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACjF,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;YAChD,KAAK,KAAK;gBACR,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;YAChD,KAAK,KAAK;gBACR,uGAAuG;gBACvG,cAAc;gBACd,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;YACjE;gBACE,iGAAiG;gBACjG,MAAM,cAAc,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;gBAChF,IAAI,CAAC,cAAc,EAAE;oBACnB,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,CAAC;iBAChE;gBACD,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,iCAAM,cAAc,KAAE,YAAY,EAAE,KAAK,IAAG,CAAC;gBAC1F,OAAO;oBACL,MAAM,EAAE,SAAS,CAAC,yBAAyB;oBAC3C,mBAAmB,EAAE,CAAC,GAAG,SAAS,CAAC,mBAAmB,CAAC;iBACxD,CAAC;SACL;IACH,CAAC;IAEO,mBAAmB,CAAC,YAA4B;QACtD,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAE,YAA+B,CAAC,MAAM,CAAC,CAAC;QACtF,OAAO;YACL,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,CAAC,MAAM,EAAE;YACvD,mBAAmB,EAAE,CAAC,GAAG,cAAc,CAAC,mBAAmB,CAAC;SAC7D,CAAC;IACJ,CAAC;CACF;AAzKD,4CAyKC"}

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.2",
+  "version": "2.9.0-alpha.1",
   "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",
@@ -36,11 +37,12 @@
   "devDependencies": {
     "@types/html-entities": "^1.3.4",
     "@types/jest": "^27.4.1",
+    "@types/js-yaml": "^4.0.5",
     "@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 +53,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 +66,10 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "1.11.0",
+    "@cparra/apex-reflection": "2.0.1",
     "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) {

package/src/cli/generate.ts

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 import * as yargs from 'yargs';
 
-import { GeneratorChoices, Settings } from '../settings';
+import { Settings } from '../settings';
 import { Apexdocs } from '../application/Apexdocs';
+import { GeneratorChoices } from '../transpiler/generator-choices';
 
 const argv = yargs.options({
   sourceDir: {
@@ -29,15 +30,17 @@ const argv = yargs.options({
     default: ['global'],
     describe:
       'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
-      'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled',
+      'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
+      'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
   },
   targetGenerator: {
     type: 'string',
     alias: 'g',
     default: 'jekyll',
-    choices: ['jekyll', 'docsify', 'plain-markdown'],
+    choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
     describe:
-      'Define the static file generator for which the documents will be created. Currently supports jekyll, docsify, and plain markdown.',
+      'Define the static file generator for which the documents will be created. ' +
+      'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
   },
   indexOnly: {
     type: 'boolean',
@@ -58,6 +61,11 @@ const argv = yargs.options({
       'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
       'Content in @example blocks are never sanitized.',
   },
+  openApiTitle: {
+    type: 'string',
+    default: 'Apex REST Api',
+    describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
+  },
 }).argv;
 
 Settings.build({
@@ -69,6 +77,7 @@ Settings.build({
   indexOnly: argv.indexOnly,
   defaultGroupName: argv.defaultGroupName,
   sanitizeHtml: argv.sanitizeHtml,
+  openApiTitle: argv.openApiTitle,
 });
 
 Apexdocs.generate();

package/src/model/apex-type-wrappers/ClassMirrorWrapper.ts

@@ -0,0 +1,12 @@
+import { ClassMirror, MethodMirror } from '@cparra/apex-reflection';
+
+export class ClassMirrorWrapper {
+  constructor(public classMirror: ClassMirror) {}
+
+  getMethodsByAnnotation(annotation: string): MethodMirror[] {
+    return this.classMirror.methods.filter((method) => this.hasAnnotation(method, annotation));
+  }
+
+  private hasAnnotation = (method: MethodMirror, annotationName: string) =>
+    method.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
+}

package/src/model/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts

@@ -0,0 +1,15 @@
+import { ClassMirrorBuilder } from '../../../test-helpers/ClassMirrorBuilder';
+import { ClassMirrorWrapper } from '../ClassMirrorWrapper';
+import { AnnotationBuilder } from '../../../test-helpers/AnnotationBuilder';
+import { MethodMirrorBuilder } from '../../../test-helpers/MethodMirrorBuilder';
+
+it('should return methods by annotation when they exist', function () {
+  const classMirror = new ClassMirrorBuilder()
+    .addMethod(new MethodMirrorBuilder().addAnnotation(new AnnotationBuilder().withName('httpget').build()).build())
+    .build();
+
+  const classMirrorWrapper = new ClassMirrorWrapper(classMirror);
+  const foundMethods = classMirrorWrapper.getMethodsByAnnotation('httpget');
+
+  expect(foundMethods.length).toBe(1);
+});

package/src/model/markdown-file.ts

@@ -1,7 +1,7 @@
-import { File } from './file';
+import { OutputFile } from './outputFile';
 import ClassFileGeneratorHelper from '../transpiler/markdown/class-file-generatorHelper';
 
-export class MarkdownFile extends File {
+export class MarkdownFile extends OutputFile {
   fileExtension(): string {
     return '.md';
   }

package/src/model/markdown-generation-util/field-declaration-util.ts

@@ -28,7 +28,10 @@ function addFieldSection(
   grouped: boolean,
 ) {
   if (!grouped) {
-    markdownFile.addTitle(`\`${mirrorModel.name}\` → \`${mirrorModel.type}\``, startingHeadingLevel + 2);
+    markdownFile.addTitle(
+      `\`${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``,
+      startingHeadingLevel + 2,
+    );
     markdownFile.addBlankLine();
     if (mirrorModel.inherited) {
       markdownFile.addText('*Inherited*');
@@ -62,7 +65,7 @@ function addFieldSection(
       description = ` - ${mirrorModel.docComment?.description}`;
     }
     markdownFile.addListItem(
-      `\`${mirrorModel.name}\` → \`${mirrorModel.type}\` (*Inherited*) ${annotations} ${description}`,
+      `\`${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\` (*Inherited*) ${annotations} ${description}`,
     );
     markdownFile.addBlankLine();
   }

package/src/model/markdown-generation-util/method-declaration-util.ts

@@ -68,7 +68,9 @@ function buildSignature(name: string, parameterAware: ParameterAware): string {
   if (isMethod(parameterAware) && (parameterAware as MethodMirrorWithInheritance).memberModifiers.length) {
     signature = (parameterAware as MethodMirrorWithInheritance).memberModifiers.join(' ') + ' ' + signature;
   }
-  const signatureParameters = parameterAware.parameters.map((param) => `${param.type} ${param.name}`);
+  const signatureParameters = parameterAware.parameters.map(
+    (param) => `${param.typeReference.rawDeclaration} ${param.name}`,
+  );
   signature += signatureParameters.join(', ');
   return `${signature})`;
 }
@@ -108,7 +110,7 @@ function addReturns(
   markdownFile.addBlankLine();
   markdownFile.addText('**Type**');
   markdownFile.addBlankLine();
-  markdownFile.addText(methodModel.type);
+  markdownFile.addText(methodModel.typeReference.rawDeclaration);
   markdownFile.addBlankLine();
   markdownFile.addText('**Description**');
   markdownFile.addBlankLine();
@@ -146,5 +148,5 @@ function addExample(markdownFile: MarkdownFile, docCommentAware: DocCommentAware
 function isMethod(
   method: MethodMirrorWithInheritance | ConstructorMirror | ParameterAware,
 ): method is ConstructorMirror {
-  return (method as MethodMirrorWithInheritance).type !== undefined;
+  return (method as MethodMirrorWithInheritance).typeReference.rawDeclaration !== undefined;
 }

package/src/model/markdown-generation-util/type-declaration-util.ts

@@ -75,7 +75,7 @@ function addParent(markdownFile: MarkdownFile, classMirror: ClassMirror) {
     return;
   }
 
-  const parentType = TypesRepository.getInstance().getByName(classMirror.extended_class);
+  const parentType = TypesRepository.getInstance().getFromScopedByName(classMirror.extended_class);
   if (!parentType) {
     return;
   }

package/src/model/openapi/__tests__/open-api.spec.ts

@@ -0,0 +1,22 @@
+import { OpenApi } from '../open-api';
+
+it('should get created with a title and a version', function () {
+  const openApi = new OpenApi('Test Spec', '1.0.0');
+
+  expect(openApi.info.title).toBe('Test Spec');
+  expect(openApi.info.version).toBe('1.0.0');
+});
+
+it('should contain a single server, which points to the correct server URL', function () {
+  const openApi = new OpenApi('Test Spec', '1.0.0');
+
+  expect(openApi.servers.length).toBe(1);
+  expect(openApi.servers[0].url).toBe('/services/apexrest/');
+});
+
+it('should optionally allow for a namespace to be passed in as part of the server', function () {
+  const openApi = new OpenApi('Test Spec', '1.0.0', 'Namespace');
+
+  expect(openApi.servers.length).toBe(1);
+  expect(openApi.servers[0].url).toBe('/services/apexrest/Namespace/');
+});

package/src/model/openapi/apex-doc-types.ts

@@ -0,0 +1,25 @@
+// These are types that represent how the data is expected to be created in the ApexDoc (as YAML), which
+// in some cases might be different from the official OpenApi spec for simplicity when writing the ApexDoc.
+
+import { SchemaObjectArray, SchemaObjectObject } from './open-api-types';
+
+export type ApexDocHttpResponse = {
+  statusCode: number;
+  schema: ApexDocSchemaObject;
+};
+
+export type ApexDocHttpRequestBody = {
+  description?: string;
+  schema: ApexDocSchemaObject;
+  required?: boolean;
+};
+
+export type ApexDocParameterObject = {
+  name: string;
+  in: 'query' | 'header' | 'path' | 'cookie';
+  description?: string;
+  required?: boolean;
+  schema: ApexDocSchemaObject;
+};
+
+export type ApexDocSchemaObject = SchemaObjectObject | SchemaObjectArray | string;