@cparra/apexdocs 2.8.2 → 2.9.0-alpha.1

package/lib/test-helpers/FieldMirrorBuilder.d.ts

@@ -0,0 +1,16 @@
+import { FieldMirror } from '@cparra/apex-reflection';
+import { ReferencedType } from '@cparra/apex-reflection/index';
+type MemberModifier = 'static' | 'webservice' | 'final' | 'override' | 'testmethod' | 'transient';
+export declare class FieldMirrorBuilder {
+    private accessModifier;
+    private name;
+    private memberModifiers;
+    private type;
+    withAccessModifier(accessModifier: string): FieldMirrorBuilder;
+    withName(name: string): FieldMirrorBuilder;
+    withType(type: string): FieldMirrorBuilder;
+    withReferencedType(type: ReferencedType): FieldMirrorBuilder;
+    addMemberModifier(memberModifier: MemberModifier): FieldMirrorBuilder;
+    build(): FieldMirror;
+}
+export {};

package/lib/test-helpers/FieldMirrorBuilder.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldMirrorBuilder = void 0;
+class FieldMirrorBuilder {
+    constructor() {
+        this.accessModifier = 'public';
+        this.name = 'fieldName';
+        this.memberModifiers = [];
+        this.type = {
+            type: 'String',
+            rawDeclaration: 'String',
+        };
+    }
+    withAccessModifier(accessModifier) {
+        this.accessModifier = accessModifier;
+        return this;
+    }
+    withName(name) {
+        this.name = name;
+        return this;
+    }
+    withType(type) {
+        this.type = {
+            rawDeclaration: type,
+            type: type,
+        };
+        return this;
+    }
+    withReferencedType(type) {
+        this.type = type;
+        return this;
+    }
+    addMemberModifier(memberModifier) {
+        this.memberModifiers.push(memberModifier);
+        return this;
+    }
+    build() {
+        return {
+            access_modifier: this.accessModifier,
+            annotations: [],
+            name: this.name,
+            memberModifiers: this.memberModifiers,
+            typeReference: this.type,
+        };
+    }
+}
+exports.FieldMirrorBuilder = FieldMirrorBuilder;
+//# sourceMappingURL=FieldMirrorBuilder.js.map

package/lib/test-helpers/FieldMirrorBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FieldMirrorBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/FieldMirrorBuilder.ts"],"names":[],"mappings":";;;AAKA,MAAa,kBAAkB;IAA/B;QACU,mBAAc,GAAG,QAAQ,CAAC;QAC1B,SAAI,GAAG,WAAW,CAAC;QACnB,oBAAe,GAAqB,EAAE,CAAC;QACvC,SAAI,GAAmB;YAC7B,IAAI,EAAE,QAAQ;YACd,cAAc,EAAE,QAAQ;SACzB,CAAC;IAuCJ,CAAC;IArCC,kBAAkB,CAAC,cAAsB;QACvC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG;YACV,cAAc,EAAE,IAAI;YACpB,IAAI,EAAE,IAAI;SACX,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB,CAAC,IAAoB;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iBAAiB,CAAC,cAA8B;QAC9C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,cAAc;YACpC,WAAW,EAAE,EAAE;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,aAAa,EAAE,IAAI,CAAC,IAAI;SACzB,CAAC;IACJ,CAAC;CACF;AA9CD,gDA8CC"}

package/lib/test-helpers/MethodMirrorBuilder.d.ts

@@ -0,0 +1,10 @@
+import { Annotation, DocComment, MethodMirror } from '@cparra/apex-reflection';
+export declare class MethodMirrorBuilder {
+    private name;
+    private annotations;
+    private docComment?;
+    withName(name: string): MethodMirrorBuilder;
+    addAnnotation(annotation: Annotation): MethodMirrorBuilder;
+    withDocComment(docComment: DocComment): MethodMirrorBuilder;
+    build(): MethodMirror;
+}

package/lib/test-helpers/MethodMirrorBuilder.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodMirrorBuilder = void 0;
+class MethodMirrorBuilder {
+    constructor() {
+        this.name = 'sampleMethod';
+        this.annotations = [];
+    }
+    withName(name) {
+        this.name = name;
+        return this;
+    }
+    addAnnotation(annotation) {
+        this.annotations.push(annotation);
+        return this;
+    }
+    withDocComment(docComment) {
+        this.docComment = docComment;
+        return this;
+    }
+    build() {
+        return {
+            access_modifier: 'public',
+            annotations: this.annotations,
+            name: this.name,
+            memberModifiers: [],
+            typeReference: {
+                type: 'void',
+                rawDeclaration: 'void',
+            },
+            parameters: [],
+            docComment: this.docComment,
+        };
+    }
+}
+exports.MethodMirrorBuilder = MethodMirrorBuilder;
+//# sourceMappingURL=MethodMirrorBuilder.js.map

package/lib/test-helpers/MethodMirrorBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MethodMirrorBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/MethodMirrorBuilder.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;IAAhC;QACU,SAAI,GAAG,cAAc,CAAC;QACtB,gBAAW,GAAiB,EAAE,CAAC;IAgCzC,CAAC;IA7BC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,UAAsB;QAClC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,UAAsB;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,eAAe,EAAE,EAAE;YACnB,aAAa,EAAE;gBACb,IAAI,EAAE,MAAM;gBACZ,cAAc,EAAE,MAAM;aACvB;YACD,UAAU,EAAE,EAAE;YACd,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;CACF;AAlCD,kDAkCC"}

package/lib/test-helpers/SettingsBuilder.d.ts

@@ -0,0 +1,8 @@
+import { SettingsConfig } from '../settings';
+/**
+ * Builder class to create SettingsConfig objects.
+ * For testing purposes only.
+ */
+export declare class SettingsBuilder {
+    build(): SettingsConfig;
+}

package/lib/test-helpers/SettingsBuilder.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsBuilder = void 0;
+/**
+ * Builder class to create SettingsConfig objects.
+ * For testing purposes only.
+ */
+class SettingsBuilder {
+    build() {
+        return {
+            sourceDirectory: './',
+            recursive: true,
+            scope: [],
+            outputDir: './',
+            targetGenerator: 'openapi',
+            indexOnly: false,
+            defaultGroupName: 'Misc',
+            sanitizeHtml: true,
+            openApiTitle: 'Apex API',
+        };
+    }
+}
+exports.SettingsBuilder = SettingsBuilder;
+//# sourceMappingURL=SettingsBuilder.js.map

package/lib/test-helpers/SettingsBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/SettingsBuilder.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,eAAe;IAC1B,KAAK;QACH,OAAO;YACL,eAAe,EAAE,IAAI;YACrB,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;YACT,SAAS,EAAE,IAAI;YACf,eAAe,EAAE,SAAS;YAC1B,SAAS,EAAE,KAAK;YAChB,gBAAgB,EAAE,MAAM;YACxB,YAAY,EAAE,IAAI;YAClB,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;CACF;AAdD,0CAcC"}

package/lib/transpiler/factory.d.ts

@@ -0,0 +1,6 @@
+import ProcessorTypeTranspiler from './processor-type-transpiler';
+import { GeneratorChoices } from './generator-choices';
+export declare class TypeTranspilerFactory {
+    private static typeTranspilerCache?;
+    static get(generator: GeneratorChoices): ProcessorTypeTranspiler;
+}

package/lib/transpiler/factory.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeTranspilerFactory = void 0;
+const jekyll_docsProcessor_1 = require("./markdown/jekyll/jekyll-docsProcessor");
+const docsify_docs_processor_1 = require("./markdown/docsify/docsify-docs-processor");
+const plain_docsProcessor_1 = require("./markdown/plain-markdown/plain-docsProcessor");
+const open_api_docs_processor_1 = require("./openapi/open-api-docs-processor");
+class TypeTranspilerFactory {
+    static get(generator) {
+        if (this.typeTranspilerCache) {
+            return this.typeTranspilerCache;
+        }
+        switch (generator) {
+            case 'jekyll':
+                this.typeTranspilerCache = new jekyll_docsProcessor_1.JekyllDocsProcessor();
+                return this.typeTranspilerCache;
+            case 'docsify':
+                this.typeTranspilerCache = new docsify_docs_processor_1.default();
+                return this.typeTranspilerCache;
+            case 'plain-markdown':
+                this.typeTranspilerCache = new plain_docsProcessor_1.PlainMarkdownDocsProcessor();
+                return this.typeTranspilerCache;
+            case 'openapi':
+                this.typeTranspilerCache = new open_api_docs_processor_1.OpenApiDocsProcessor();
+                return this.typeTranspilerCache;
+            default:
+                throw Error('Invalid target generator');
+        }
+    }
+}
+exports.TypeTranspilerFactory = TypeTranspilerFactory;
+//# sourceMappingURL=factory.js.map

package/lib/transpiler/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/transpiler/factory.ts"],"names":[],"mappings":";;;AAEA,iFAA6E;AAC7E,sFAA6E;AAC7E,uFAA2F;AAC3F,+EAAyE;AAEzE,MAAa,qBAAqB;IAGzB,MAAM,CAAC,GAAG,CAAC,SAA2B;QAC3C,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5B,OAAO,IAAI,CAAC,mBAAmB,CAAC;SACjC;QAED,QAAQ,SAAS,EAAE;YACjB,KAAK,QAAQ;gBACX,IAAI,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,gBAAgB;gBACnB,IAAI,CAAC,mBAAmB,GAAG,IAAI,gDAA0B,EAAE,CAAC;gBAC5D,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,GAAG,IAAI,8CAAoB,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;CACF;AAzBD,sDAyBC"}

package/lib/transpiler/file-container.d.ts

@@ -1,6 +1,6 @@
-import { File } from '../model/file';
+import { OutputFile } from '../model/outputFile';
 export declare class FileContainer {
-    _files: File[];
-    files(): File[];
-    pushFile(file: File): void;
+    _files: OutputFile[];
+    files(): OutputFile[];
+    pushFile(file: OutputFile): void;
 }

package/lib/transpiler/file-container.js.map

@@ -1 +1 @@
-{"version":3,"file":"file-container.js","sourceRoot":"","sources":["../../src/transpiler/file-container.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IAA1B;QACE,WAAM,GAAW,EAAE,CAAC;IAStB,CAAC;IAPC,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,IAAU;QACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACF;AAVD,sCAUC"}
+{"version":3,"file":"file-container.js","sourceRoot":"","sources":["../../src/transpiler/file-container.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IAA1B;QACE,WAAM,GAAiB,EAAE,CAAC;IAS5B,CAAC;IAPC,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,IAAgB;QACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACF;AAVD,sCAUC"}

package/lib/transpiler/generator-choices.d.ts

@@ -0,0 +1 @@
+export type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown' | 'openapi';

package/lib/transpiler/generator-choices.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generator-choices.js.map

package/lib/transpiler/generator-choices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator-choices.js","sourceRoot":"","sources":["../../src/transpiler/generator-choices.ts"],"names":[],"mappings":""}

package/lib/transpiler/markdown/class-file-generatorHelper.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const types_repository_1 = require("../../model/types-repository");
 const settings_1 = require("../../settings");
 const state_1 = require("../../service/state");
+const factory_1 = require("../factory");
 class ClassFileGeneratorHelper {
     static getSanitizedGroup(classModel) {
         return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
@@ -12,7 +13,7 @@ class ClassFileGeneratorHelper {
         return `[${classModel.name}](${directoryRoot}${classModel.name}.md)`;
     }
     static getFileLinkByTypeName(typeName) {
-        const type = types_repository_1.TypesRepository.getInstance().getByName(typeName);
+        const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
         if (!type) {
             // If the type is not found we return a Markdown hyperlink with whatever we received.
             return `[${typeName}](${typeName})`;
@@ -21,7 +22,8 @@ class ClassFileGeneratorHelper {
     }
     static getDirectoryRoot(classModel) {
         // root-relative links start from the root by using a leading '/'
-        if (settings_1.Settings.getInstance().typeTranspiler.getLinkingStrategy() === 'root-relative') {
+        const generator = settings_1.Settings.getInstance().targetGenerator;
+        if (factory_1.TypeTranspilerFactory.get(generator).getLinkingStrategy() === 'root-relative') {
             return `/${this.getSanitizedGroup(classModel)}/`;
         }
         // path-relative links traverse the directory structure

package/lib/transpiler/markdown/class-file-generatorHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,+CAAwC;AAExC,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,IAAI,UAAU,CAAC,IAAI,KAAK,aAAa,GAAG,UAAU,CAAC,IAAI,MAAM,CAAC;IACvE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,EAAE;YACT,qFAAqF;YACrF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YAClF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SAClD;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAC7E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,uEAAuE;gBACvE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,sGAAsG;YACtG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAhDD,2CAgDC"}
+{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,+CAAwC;AACxC,wCAAmD;AAEnD,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,IAAI,UAAU,CAAC,IAAI,KAAK,aAAa,GAAG,UAAU,CAAC,IAAI,MAAM,CAAC;IACvE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,qFAAqF;YACrF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YACjF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SAClD;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAC7E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,uEAAuE;gBACvE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,sGAAsG;YACtG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAjDD,2CAiDC"}

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

@@ -0,0 +1,12 @@
+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;
+    private getEndpointPath;
+}

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.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,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,106 @@
+"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: {},
+            };
+        }
+        if (!reference.referenceComponents.length) {
+            return;
+        }
+        // Add all received references to the OpenApi components section.
+        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;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,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE;YACzC,OAAO;SACR;QAED,iEAAiE;QACjE,SAAS,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAChD,uEAAuE;YACvE,IAAI,CAAC,YAAY,CAAC,UAAW,CAAC,OAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxHD,oCAwHC"}

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,31 @@
+import { ReferenceObject, SchemaObjectArray, SchemaObjectObject } from '../../../model/openapi/open-api-types';
+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 getReferenceName;
+    private buildMainReferenceComponent;
+    private getReferenceType;
+    private buildCollectionPair;
+}
+/**
+ * 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;
+};