@cparra/apexdocs 2.8.2 → 2.9.0-alpha.1

package/lib/model/openapi/open-api-types.d.ts

@@ -0,0 +1,87 @@
+export type InfoObject = {
+    title: string;
+    version: string;
+};
+export type ServerObject = {
+    url: string;
+};
+export type PathsObject = {
+    [index: string]: PathItemObject;
+};
+export type PathItemObject = {
+    description?: string;
+    get?: OperationObject;
+    put?: OperationObject;
+    post?: OperationObject;
+    delete?: OperationObject;
+    patch?: OperationObject;
+};
+export type OperationObject = {
+    description?: string;
+    requestBody?: RequestBody;
+    parameters?: ParameterObject[];
+    responses?: ResponsesObject;
+};
+export type ParameterObject = {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema?: SchemaObject;
+};
+export type RequestBody = {
+    description?: string;
+    content: RequestBodyContent;
+    required?: boolean;
+};
+export type RequestBodyContent = {
+    [index: string]: MediaTypeObject;
+};
+export type MediaTypeObject = {
+    schema?: SchemaObject;
+    example?: any;
+    examples?: {
+        [index: string]: ExampleObject;
+    };
+};
+export type ExampleObject = {
+    summary?: string;
+    description?: string;
+    value?: any;
+};
+export type ResponsesObject = {
+    [index: string]: ResponseObject;
+};
+export type ResponseObject = {
+    description: string;
+    content?: ContentObject;
+};
+export type ContentObject = {
+    [index: string]: {
+        schema: SchemaObject;
+    };
+};
+export type SchemaObject = SchemaObjectObject | SchemaObjectArray | ReferenceObject;
+export type SchemaObjectObject = {
+    type: string;
+    properties?: PropertiesObject;
+    format?: string;
+    description?: string;
+};
+export type PropertiesObject = {
+    [index: string]: SchemaObject;
+};
+export type SchemaObjectArray = {
+    type: 'array';
+    items: SchemaObject;
+    description?: string;
+};
+export type ReferenceObject = {
+    $ref: string;
+    description?: string;
+};
+export type ComponentsObject = {
+    schemas: {
+        [index: string]: SchemaObject;
+    };
+};

package/lib/model/openapi/open-api-types.js

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

package/lib/model/openapi/open-api-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-api-types.js","sourceRoot":"","sources":["../../../src/model/openapi/open-api-types.ts"],"names":[],"mappings":""}

package/lib/model/openapi/open-api.d.ts

@@ -0,0 +1,15 @@
+import { ComponentsObject, InfoObject, PathsObject, ServerObject } from './open-api-types';
+/**
+ * Represents the OpenApi 3.1.0 spec
+ * https://spec.openapis.org/oas/v3.1.0
+ */
+export declare class OpenApi {
+    namespace?: string | undefined;
+    openapi: string;
+    info: InfoObject;
+    paths: PathsObject;
+    servers: ServerObject[];
+    components?: ComponentsObject;
+    constructor(title: string, version: string, namespace?: string | undefined);
+    private getServerUrl;
+}

package/lib/model/openapi/open-api.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApi = void 0;
+const OPEN_API_VERSION = '3.1.0';
+const SERVER_URL = '/services/apexrest/';
+/**
+ * Represents the OpenApi 3.1.0 spec
+ * https://spec.openapis.org/oas/v3.1.0
+ */
+class OpenApi {
+    constructor(title, version, namespace) {
+        this.namespace = namespace;
+        this.openapi = OPEN_API_VERSION;
+        this.info = {
+            title: title,
+            version: version,
+        };
+        this.servers = [
+            {
+                url: this.getServerUrl(),
+            },
+        ];
+        this.paths = {};
+    }
+    getServerUrl() {
+        if (!this.namespace) {
+            return SERVER_URL;
+        }
+        return `${SERVER_URL}${this.namespace}/`;
+    }
+}
+exports.OpenApi = OpenApi;
+//# sourceMappingURL=open-api.js.map

package/lib/model/openapi/open-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-api.js","sourceRoot":"","sources":["../../../src/model/openapi/open-api.ts"],"names":[],"mappings":";;;AAEA,MAAM,gBAAgB,GAAG,OAAO,CAAC;AACjC,MAAM,UAAU,GAAG,qBAAqB,CAAC;AAEzC;;;GAGG;AACH,MAAa,OAAO;IAOlB,YAAY,KAAa,EAAE,OAAe,EAAS,SAAkB;QAAlB,cAAS,GAAT,SAAS,CAAS;QANrE,YAAO,GAAG,gBAAgB,CAAC;QAOzB,IAAI,CAAC,IAAI,GAAG;YACV,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,OAAO;SACjB,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG;YACb;gBACE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE;aACzB;SACF,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAO,UAAU,CAAC;SACnB;QAED,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,GAAG,CAAC;IAC3C,CAAC;CACF;AA7BD,0BA6BC"}

package/lib/model/openapi/openapi-type-file.d.ts

@@ -0,0 +1,7 @@
+import { OutputFile } from '../outputFile';
+import { OpenApi } from './open-api';
+export declare class OpenapiTypeFile extends OutputFile {
+    openApiModel: OpenApi;
+    constructor(openApiModel: OpenApi);
+    fileExtension(): string;
+}

package/lib/model/openapi/openapi-type-file.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenapiTypeFile = void 0;
+const outputFile_1 = require("../outputFile");
+class OpenapiTypeFile extends outputFile_1.OutputFile {
+    constructor(openApiModel) {
+        super('openapi', '');
+        this.openApiModel = openApiModel;
+        this.addText(JSON.stringify(openApiModel, null, 2));
+    }
+    fileExtension() {
+        return '.json';
+    }
+}
+exports.OpenapiTypeFile = OpenapiTypeFile;
+//# sourceMappingURL=openapi-type-file.js.map

package/lib/model/openapi/openapi-type-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-type-file.js","sourceRoot":"","sources":["../../../src/model/openapi/openapi-type-file.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAG3C,MAAa,eAAgB,SAAQ,uBAAU;IAC7C,YAAmB,YAAqB;QACtC,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QADJ,iBAAY,GAAZ,YAAY,CAAS;QAEtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,aAAa;QACX,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AATD,0CASC"}

package/lib/model/{file.d.ts → outputFile.d.ts}

@@ -1,4 +1,4 @@
-export declare abstract class File {
+export declare abstract class OutputFile {
     fileName: string;
     dir: string;
     _contents: string;

package/lib/model/{file.js → outputFile.js}

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.File = void 0;
+exports.OutputFile = void 0;
 const xss = require("xss");
 const settings_1 = require("../settings");
 const xssFilter = new xss.FilterXSS({
     whiteList: { br: [], p: [], ul: [], li: [], code: [], pre: [] },
 });
-class File {
+class OutputFile {
     constructor(fileName, dir) {
         this.fileName = fileName;
         this.dir = dir;
@@ -25,5 +25,5 @@ class File {
         this._contents += '\n';
     }
 }
-exports.File = File;
-//# sourceMappingURL=file.js.map
+exports.OutputFile = OutputFile;
+//# sourceMappingURL=outputFile.js.map

package/lib/model/outputFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputFile.js","sourceRoot":"","sources":["../../src/model/outputFile.ts"],"names":[],"mappings":";;;AAAA,2BAA4B;AAC5B,0CAAuC;AAEvC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC;IAClC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;CAChE,CAAC,CAAC;AAEH,MAAsB,UAAU;IAG9B,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,YAAY,GAAG,UAAU,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC;QACvE,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AArBD,gCAqBC"}

package/lib/model/types-repository.d.ts

@@ -1,8 +1,16 @@
 import { Type } from '@cparra/apex-reflection';
+export type TypeBundle = {
+    type: Type;
+    isChild: boolean;
+    parentType?: Type;
+};
 export declare class TypesRepository {
     private static instance;
-    private types;
+    private scopedTypes;
+    private allTypes;
     static getInstance(): TypesRepository;
-    populate(types: Type[]): void;
-    getByName(typeName: string): Type | undefined;
+    populateAll(types: Type[]): void;
+    getFromAllByName(typeName: string): TypeBundle | undefined;
+    populateScoped(types: Type[]): void;
+    getFromScopedByName(typeName: string): Type | undefined;
 }

package/lib/model/types-repository.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypesRepository = void 0;
 class TypesRepository {
     constructor() {
-        this.types = [];
+        this.scopedTypes = [];
+        this.allTypes = [];
     }
     static getInstance() {
         if (!TypesRepository.instance) {
@@ -11,11 +12,42 @@ class TypesRepository {
         }
         return TypesRepository.instance;
     }
-    populate(types) {
-        this.types = types;
+    populateAll(types) {
+        this.allTypes = types;
     }
-    getByName(typeName) {
-        return this.types.find((currentType) => currentType.name === typeName);
+    getFromAllByName(typeName) {
+        if (typeName.includes('.')) {
+            // If it includes a dot we are assuming we are dealing with an inner class.
+            const [parentTypeName, childTypeName] = typeName.split('.');
+            const parentReference = this.allTypes.find((currentType) => currentType.name.toLowerCase() === parentTypeName.toLowerCase());
+            if (!parentReference || parentReference.type_name !== 'class') {
+                // If the parent is not found, no reason to keep searching, instead we return undefined.
+                // Similarly, if the parent is not a class, it means it cannot have children, so we return early.
+                return undefined;
+            }
+            const parentReferenceAsClass = parentReference;
+            const childTypes = [
+                ...parentReferenceAsClass.classes,
+                ...parentReferenceAsClass.interfaces,
+                ...parentReferenceAsClass.enums,
+            ];
+            const foundType = childTypes.find((currentType) => currentType.name.toLowerCase() === childTypeName);
+            if (!foundType) {
+                return undefined;
+            }
+            return { type: foundType, isChild: true, parentType: parentReference };
+        }
+        const foundType = this.allTypes.find((currentType) => currentType.name.toLowerCase() === typeName.toLowerCase());
+        if (!foundType) {
+            return undefined;
+        }
+        return { type: foundType, isChild: false };
+    }
+    populateScoped(types) {
+        this.scopedTypes = types;
+    }
+    getFromScopedByName(typeName) {
+        return this.scopedTypes.find((currentType) => currentType.name === typeName);
     }
 }
 exports.TypesRepository = TypesRepository;

package/lib/model/types-repository.js.map

@@ -1 +1 @@
-{"version":3,"file":"types-repository.js","sourceRoot":"","sources":["../../src/model/types-repository.ts"],"names":[],"mappings":";;;AAEA,MAAa,eAAe;IAA5B;QAEU,UAAK,GAAW,EAAE,CAAC;IAgB7B,CAAC;IAdQ,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;YAC7B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;SAClD;QACD,OAAO,eAAe,CAAC,QAAQ,CAAC;IAClC,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC3B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,SAAS,CAAC,QAAgB;QAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;IAC/E,CAAC;CACF;AAlBD,0CAkBC"}
+{"version":3,"file":"types-repository.js","sourceRoot":"","sources":["../../src/model/types-repository.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IAA5B;QAEU,gBAAW,GAAW,EAAE,CAAC;QACzB,aAAQ,GAAW,EAAE,CAAC;IAuDhC,CAAC;IArDQ,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;YAC7B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;SAClD;QACD,OAAO,eAAe,CAAC,QAAQ,CAAC;IAClC,CAAC;IAEM,WAAW,CAAC,KAAa;QAC9B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAEM,gBAAgB,CAAC,QAAgB;QACtC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC1B,2EAA2E;YAC3E,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC5D,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CACxC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE,CACvF,CAAC;YACF,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,SAAS,KAAK,OAAO,EAAE;gBAC7D,wFAAwF;gBACxF,iGAAiG;gBACjG,OAAO,SAAS,CAAC;aAClB;YAED,MAAM,sBAAsB,GAAG,eAA8B,CAAC;YAC9D,MAAM,UAAU,GAAG;gBACjB,GAAG,sBAAsB,CAAC,OAAO;gBACjC,GAAG,sBAAsB,CAAC,UAAU;gBACpC,GAAG,sBAAsB,CAAC,KAAK;aAChC,CAAC;YACF,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CAAC,CAAC;YAC3G,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC;SACxE;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAClC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CACjF,CAAC;QACF,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC7C,CAAC;IAEM,cAAc,CAAC,KAAa;QACjC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAEM,mBAAmB,CAAC,QAAgB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;IACrF,CAAC;CACF;AA1DD,0CA0DC"}

package/lib/service/file-writer.d.ts

@@ -1,4 +1,4 @@
-import { File } from '../model/file';
+import { OutputFile } from '../model/outputFile';
 export declare class FileWriter {
-    static write(files: File[], onWriteCallback: (fileName: string) => void): void;
+    static write(files: OutputFile[], onWriteCallback: (fileName: string) => void): void;
 }

package/lib/service/file-writer.js.map

@@ -1 +1 @@
-{"version":3,"file":"file-writer.js","sourceRoot":"","sources":["../../src/service/file-writer.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAE7B,0CAAuC;AAEvC,MAAa,UAAU;IACrB,MAAM,CAAC,KAAK,CAAC,KAAa,EAAE,eAA2C;QACrE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC;QACnD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAC7B,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACzB;QAED,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;gBAC3B,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;aACvB;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC/E,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;gBAC7C,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnBD,gCAmBC"}
+{"version":3,"file":"file-writer.js","sourceRoot":"","sources":["../../src/service/file-writer.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAE7B,0CAAuC;AAEvC,MAAa,UAAU;IACrB,MAAM,CAAC,KAAK,CAAC,KAAmB,EAAE,eAA2C;QAC3E,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC;QACnD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAC7B,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACzB;QAED,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;gBAC3B,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;aACvB;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC/E,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;gBAC7C,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnBD,gCAmBC"}

package/lib/service/metadata-processor.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadata-processor.js","sourceRoot":"","sources":["../../src/service/metadata-processor.ts"],"names":[],"mappings":";;AAAA,qDAA4C;AAE5C,MAAqB,iBAAiB;IAC7B,MAAM,CAAC,OAAO,CAAC,KAAa;;QACjC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;QACtC,MAAM,GAAG,GAAG,IAAI,2BAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEzC,GAAG,CAAC,GAAG,CAAC,YAAY,QAAE,GAAG,CAAC,SAAS,CAAC,UAAU,mCAAI,EAAE,CAAC,CAAC;QAEtD,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE;YACxB,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SACzC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAbD,oCAaC"}
+{"version":3,"file":"metadata-processor.js","sourceRoot":"","sources":["../../src/service/metadata-processor.ts"],"names":[],"mappings":";;AAAA,qDAA4C;AAE5C,MAAqB,iBAAiB;IAC7B,MAAM,CAAC,OAAO,CAAC,KAAa;;QACjC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;QACtC,MAAM,GAAG,GAAG,IAAI,2BAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEzC,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,MAAA,GAAG,CAAC,SAAS,CAAC,UAAU,mCAAI,EAAE,CAAC,CAAC;QAEtD,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE;YACxB,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SACzC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAbD,oCAaC"}

package/lib/service/parser.d.ts

@@ -3,7 +3,7 @@ import ApexBundle from '../model/apex-bundle';
 export interface TypeParser {
     parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
 }
-declare type NameAware = {
+type NameAware = {
     name: string;
 };
 export declare class RawBodyParser implements TypeParser {

package/lib/settings.d.ts

@@ -1,5 +1,4 @@
-import ProcessorTypeTranspiler from './transpiler/processor-type-transpiler';
-export declare type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown';
+import { GeneratorChoices } from './transpiler/generator-choices';
 export interface SettingsConfig {
     sourceDirectory: string;
     recursive: boolean;
@@ -9,6 +8,7 @@ export interface SettingsConfig {
     indexOnly: boolean;
     defaultGroupName: string;
     sanitizeHtml: boolean;
+    openApiTitle?: string;
 }
 export declare class Settings {
     config: SettingsConfig;
@@ -20,10 +20,9 @@ export declare class Settings {
     get recursive(): boolean;
     get scope(): string[];
     get outputDir(): string;
-    private static typeTranspilerCache?;
-    get typeTranspiler(): ProcessorTypeTranspiler;
+    get targetGenerator(): GeneratorChoices;
     get indexOnly(): boolean;
     get sanitizeHtml(): boolean;
-    get numberOfVisibleDescriptionLinesOnHomePage(): number;
     getDefaultGroupName(): string;
+    getOpenApiTitle(): string | undefined;
 }

package/lib/settings.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Settings = void 0;
-const jekyll_docsProcessor_1 = require("./transpiler/markdown/jekyll/jekyll-docsProcessor");
-const docsify_docs_processor_1 = require("./transpiler/markdown/docsify/docsify-docs-processor");
-const plain_docsProcessor_1 = require("./transpiler/markdown/plain-markdown/plain-docsProcessor");
 class Settings {
     constructor(config) {
         this.config = config;
@@ -29,23 +26,8 @@ class Settings {
     get outputDir() {
         return this.config.outputDir;
     }
-    get typeTranspiler() {
-        if (Settings.typeTranspilerCache) {
-            return Settings.typeTranspilerCache;
-        }
-        switch (this.config.targetGenerator) {
-            case 'jekyll':
-                Settings.typeTranspilerCache = new jekyll_docsProcessor_1.JekyllDocsProcessor();
-                return Settings.typeTranspilerCache;
-            case 'docsify':
-                Settings.typeTranspilerCache = new docsify_docs_processor_1.default();
-                return Settings.typeTranspilerCache;
-            case 'plain-markdown':
-                Settings.typeTranspilerCache = new plain_docsProcessor_1.PlainMarkdownDocsProcessor();
-                return Settings.typeTranspilerCache;
-            default:
-                throw Error('Invalid target generator');
-        }
+    get targetGenerator() {
+        return this.config.targetGenerator;
     }
     get indexOnly() {
         return this.config.indexOnly;
@@ -53,12 +35,12 @@ class Settings {
     get sanitizeHtml() {
         return this.config.sanitizeHtml;
     }
-    get numberOfVisibleDescriptionLinesOnHomePage() {
-        return 5;
-    }
     getDefaultGroupName() {
         return this.config.defaultGroupName;
     }
+    getOpenApiTitle() {
+        return this.config.openApiTitle;
+    }
 }
 exports.Settings = Settings;
 //# sourceMappingURL=settings.js.map

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AACxF,kGAAsG;AAetG,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAID,IAAI,cAAc;QAChB,IAAI,QAAQ,CAAC,mBAAmB,EAAE;YAChC,OAAO,QAAQ,CAAC,mBAAmB,CAAC;SACrC;QACD,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,QAAQ,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,SAAS;gBACZ,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBAC1D,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,gBAAgB;gBACnB,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gDAA0B,EAAE,CAAC;gBAChE,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAED,IAAI,yCAAyC;QAC3C,OAAO,CAAC,CAAC;IACX,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;CACF;AApED,4BAoEC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AAcA,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;CACF;AAnDD,4BAmDC"}

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

@@ -0,0 +1,12 @@
+import { Annotation, AnnotationElementValue } from '@cparra/apex-reflection';
+/**
+ * Builder class to create Annotation objects.
+ * For testing purposes only.
+ */
+export declare class AnnotationBuilder {
+    private name;
+    private elementValues;
+    withName(name: string): AnnotationBuilder;
+    addElementValue(elementValue: AnnotationElementValue): AnnotationBuilder;
+    build(): Annotation;
+}

package/lib/test-helpers/AnnotationBuilder.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnnotationBuilder = void 0;
+/**
+ * Builder class to create Annotation objects.
+ * For testing purposes only.
+ */
+class AnnotationBuilder {
+    constructor() {
+        this.name = 'restresource';
+        this.elementValues = [];
+    }
+    withName(name) {
+        this.name = name;
+        return this;
+    }
+    addElementValue(elementValue) {
+        this.elementValues.push(elementValue);
+        return this;
+    }
+    build() {
+        return {
+            rawDeclaration: '',
+            name: this.name,
+            type: this.name,
+            elementValues: this.elementValues,
+        };
+    }
+}
+exports.AnnotationBuilder = AnnotationBuilder;
+//# sourceMappingURL=AnnotationBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnnotationBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/AnnotationBuilder.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,iBAAiB;IAA9B;QACU,SAAI,GAAG,cAAc,CAAC;QACtB,kBAAa,GAA6B,EAAE,CAAC;IAoBvD,CAAC;IAlBC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,eAAe,CAAC,YAAoC;QAClD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,cAAc,EAAE,EAAE;YAClB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;CACF;AAtBD,8CAsBC"}

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

@@ -0,0 +1,18 @@
+import { Annotation, ClassMirror, DocComment, FieldMirror, MethodMirror } from '@cparra/apex-reflection';
+/**
+ * Builder class to create ClassMirror objects.
+ * For testing purposes only.
+ */
+export declare class ClassMirrorBuilder {
+    private name;
+    private annotations;
+    private docComment?;
+    private methods;
+    private fields;
+    withName(name: string): ClassMirrorBuilder;
+    addAnnotation(annotation: Annotation): ClassMirrorBuilder;
+    withDocComment(docComment: DocComment): ClassMirrorBuilder;
+    addMethod(method: MethodMirror): ClassMirrorBuilder;
+    addFiled(field: FieldMirror): ClassMirrorBuilder;
+    build(): ClassMirror;
+}

package/lib/test-helpers/ClassMirrorBuilder.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClassMirrorBuilder = void 0;
+/**
+ * Builder class to create ClassMirror objects.
+ * For testing purposes only.
+ */
+class ClassMirrorBuilder {
+    constructor() {
+        this.name = 'SampleClass';
+        this.annotations = [];
+        this.methods = [];
+        this.fields = [];
+    }
+    withName(name) {
+        this.name = name;
+        return this;
+    }
+    addAnnotation(annotation) {
+        this.annotations.push(annotation);
+        return this;
+    }
+    withDocComment(docComment) {
+        this.docComment = docComment;
+        return this;
+    }
+    addMethod(method) {
+        this.methods.push(method);
+        return this;
+    }
+    addFiled(field) {
+        this.fields.push(field);
+        return this;
+    }
+    build() {
+        return {
+            annotations: this.annotations,
+            name: this.name,
+            type_name: 'class',
+            methods: this.methods,
+            implemented_interfaces: [],
+            properties: [],
+            fields: this.fields,
+            constructors: [],
+            enums: [],
+            interfaces: [],
+            classes: [],
+            access_modifier: 'public',
+            docComment: this.docComment,
+        };
+    }
+}
+exports.ClassMirrorBuilder = ClassMirrorBuilder;
+//# sourceMappingURL=ClassMirrorBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClassMirrorBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/ClassMirrorBuilder.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,kBAAkB;IAA/B;QACU,SAAI,GAAG,aAAa,CAAC;QACrB,gBAAW,GAAiB,EAAE,CAAC;QAE/B,YAAO,GAAmB,EAAE,CAAC;QAC7B,WAAM,GAAkB,EAAE,CAAC;IA4CrC,CAAC;IA1CC,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,SAAS,CAAC,MAAoB;QAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,KAAkB;QACzB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,OAAO;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,sBAAsB,EAAE,EAAE;YAC1B,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE;YACT,UAAU,EAAE,EAAE;YACd,OAAO,EAAE,EAAE;YACX,eAAe,EAAE,QAAQ;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;CACF;AAjDD,gDAiDC"}

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

@@ -0,0 +1,6 @@
+import { DocCommentAnnotation } from '@cparra/apex-reflection';
+export declare class DocCommentAnnotationBuilder {
+    private name;
+    withName(name: string): DocCommentAnnotationBuilder;
+    build(): DocCommentAnnotation;
+}

package/lib/test-helpers/DocCommentAnnotationBuilder.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocCommentAnnotationBuilder = void 0;
+class DocCommentAnnotationBuilder {
+    constructor() {
+        this.name = '';
+    }
+    withName(name) {
+        this.name = name;
+        return this;
+    }
+    build() {
+        return {
+            name: this.name,
+            body: '',
+            bodyLines: [],
+        };
+    }
+}
+exports.DocCommentAnnotationBuilder = DocCommentAnnotationBuilder;
+//# sourceMappingURL=DocCommentAnnotationBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DocCommentAnnotationBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/DocCommentAnnotationBuilder.ts"],"names":[],"mappings":";;;AAEA,MAAa,2BAA2B;IAAxC;QACU,SAAI,GAAG,EAAE,CAAC;IAcpB,CAAC;IAZC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,EAAE;YACR,SAAS,EAAE,EAAE;SACd,CAAC;IACJ,CAAC;CACF;AAfD,kEAeC"}

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

@@ -0,0 +1,12 @@
+import { DocComment, DocCommentAnnotation } from '@cparra/apex-reflection';
+/**
+ * Builder class to create DocComment objects.
+ * For testing purposes only.
+ */
+export declare class DocCommentBuilder {
+    private description?;
+    private annotations;
+    addAnnotation(annotation: DocCommentAnnotation): DocCommentBuilder;
+    withDescription(description: string): DocCommentBuilder;
+    build(): DocComment;
+}

package/lib/test-helpers/DocCommentBuilder.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocCommentBuilder = void 0;
+/**
+ * Builder class to create DocComment objects.
+ * For testing purposes only.
+ */
+class DocCommentBuilder {
+    constructor() {
+        this.annotations = [];
+    }
+    addAnnotation(annotation) {
+        this.annotations.push(annotation);
+        return this;
+    }
+    withDescription(description) {
+        this.description = description;
+        return this;
+    }
+    build() {
+        var _a;
+        return {
+            paramAnnotations: [],
+            returnAnnotation: {
+                bodyLines: [],
+            },
+            exampleAnnotation: {
+                bodyLines: [],
+            },
+            throwsAnnotations: [],
+            annotations: this.annotations,
+            descriptionLines: [],
+            description: (_a = this.description) !== null && _a !== void 0 ? _a : 'Sample Description',
+        };
+    }
+}
+exports.DocCommentBuilder = DocCommentBuilder;
+//# sourceMappingURL=DocCommentBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DocCommentBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/DocCommentBuilder.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,iBAAiB;IAA9B;QAEU,gBAAW,GAA2B,EAAE,CAAC;IA2BnD,CAAC;IAzBC,aAAa,CAAC,UAAgC;QAC5C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,eAAe,CAAC,WAAmB;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;;QACH,OAAO;YACL,gBAAgB,EAAE,EAAE;YACpB,gBAAgB,EAAE;gBAChB,SAAS,EAAE,EAAE;aACd;YACD,iBAAiB,EAAE;gBACjB,SAAS,EAAE,EAAE;aACd;YACD,iBAAiB,EAAE,EAAE;YACrB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,gBAAgB,EAAE,EAAE;YACpB,WAAW,EAAE,MAAA,IAAI,CAAC,WAAW,mCAAI,oBAAoB;SACtD,CAAC;IACJ,CAAC;CACF;AA7BD,8CA6BC"}