@cparra/apexdocs 2.25.0-alpha.9 → 2.25.0

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,8 @@
+import { DocCommentAnnotation } from '@cparra/apex-reflection';
+export declare class DocCommentAnnotationBuilder {
+    private name;
+    private bodyLines;
+    withName(name: string): DocCommentAnnotationBuilder;
+    withBodyLines(bodyLines: string[]): DocCommentAnnotationBuilder;
+    build(): DocCommentAnnotation;
+}

package/lib/test-helpers/DocCommentAnnotationBuilder.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocCommentAnnotationBuilder = void 0;
+class DocCommentAnnotationBuilder {
+    constructor() {
+        this.name = '';
+        this.bodyLines = [];
+    }
+    withName(name) {
+        this.name = name;
+        return this;
+    }
+    withBodyLines(bodyLines) {
+        this.bodyLines = bodyLines;
+        return this;
+    }
+    build() {
+        return {
+            name: this.name,
+            body: '',
+            bodyLines: this.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;QACV,cAAS,GAAa,EAAE,CAAC;IAmBnC,CAAC;IAjBC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,SAAmB;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,EAAE;YACR,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;CACF;AArBD,kEAqBC"}

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"}

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

@@ -0,0 +1,18 @@
+import { DocComment, 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 docComment;
+    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;
+    withDocComment(docComment: DocComment): FieldMirrorBuilder;
+    build(): FieldMirror;
+}
+export {};

package/lib/test-helpers/FieldMirrorBuilder.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldMirrorBuilder = void 0;
+class FieldMirrorBuilder {
+    constructor() {
+        this.docComment = undefined;
+        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;
+    }
+    withDocComment(docComment) {
+        this.docComment = docComment;
+        return this;
+    }
+    build() {
+        return {
+            access_modifier: this.accessModifier,
+            annotations: [],
+            name: this.name,
+            memberModifiers: this.memberModifiers,
+            typeReference: this.type,
+            docComment: this.docComment,
+        };
+    }
+}
+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,eAAU,GAA2B,SAAS,CAAC;QAC/C,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;IA6CJ,CAAC;IA3CC,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,cAAc,CAAC,UAAsB;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,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;YACxB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;CACF;AArDD,gDAqDC"}

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,27 @@
+"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',
+            openApiFileName: 'openapi',
+            title: 'Classes',
+            includeMetadata: false,
+        };
+    }
+}
+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;YACxB,eAAe,EAAE,SAAS;YAC1B,KAAK,EAAE,SAAS;YAChB,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;CACF;AAjBD,0CAiBC"}

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

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

package/lib/transpiler/file-container.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileContainer = void 0;
+class FileContainer {
+    constructor() {
+        this._files = [];
+    }
+    files() {
+        return this._files;
+    }
+    pushFile(file) {
+        this._files.push(file);
+    }
+}
+exports.FileContainer = FileContainer;
+//# sourceMappingURL=file-container.js.map

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

@@ -0,0 +1 @@
+{"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.d.ts

@@ -0,0 +1,8 @@
+import { Type } from '@cparra/apex-reflection';
+export default class ClassFileGeneratorHelper {
+    static getSanitizedGroup(classModel: Type): string;
+    static getFileLink(classModel: Type): string;
+    static getFileLinkByTypeName(typeName: string): string;
+    private static getDirectoryRoot;
+    private static getClassGroup;
+}

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

@@ -0,0 +1,56 @@
+"use strict";
+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('.', '');
+    }
+    static getFileLink(classModel) {
+        var _a;
+        const documentationRoot = (_a = settings_1.Settings.getInstance().getRootDir()) !== null && _a !== void 0 ? _a : '';
+        const directoryRoot = `${documentationRoot}${this.getDirectoryRoot(classModel)}`;
+        const fullClassName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${classModel.name}`;
+        return `[${fullClassName}](${directoryRoot}${fullClassName}.md)`;
+    }
+    static getFileLinkByTypeName(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})`;
+        }
+        return this.getFileLink(type);
+    }
+    static getDirectoryRoot(classModel) {
+        // root-relative links start from the root by using a leading '/'
+        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
+        const typeBeingProcessed = state_1.default.getInstance().getTypeBeingProcessed();
+        if (typeBeingProcessed) {
+            if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
+                // If the types the same groups then we simply link directly to that file
+                return './';
+            }
+            else {
+                // If the types have different groups, then we have to go up a directory
+                return `../${this.getSanitizedGroup(classModel)}/`;
+            }
+        }
+        else {
+            // If nothing is being processed, then we assume we are at the root and links should include the groups
+            return `./${this.getSanitizedGroup(classModel)}/`;
+        }
+    }
+    static getClassGroup(classModel) {
+        var _a, _b;
+        const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
+        return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : settings_1.Settings.getInstance().getDefaultGroupName();
+    }
+}
+exports.default = ClassFileGeneratorHelper;
+//# sourceMappingURL=class-file-generatorHelper.js.map

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

@@ -0,0 +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;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,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,IAAI,aAAa,KAAK,aAAa,GAAG,aAAa,MAAM,CAAC;IACnE,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,sFAAsF;YACtF,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,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,uGAAuG;YACvG,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;AAnDD,2CAmDC"}

package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts

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

package/lib/transpiler/markdown/docsify/docsify-docs-processor.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
+class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
+    homeFileName() {
+        return 'README';
+    }
+    getLinkingStrategy() {
+        return 'root-relative';
+    }
+}
+exports.default = DocsifyDocsProcessor;
+//# sourceMappingURL=docsify-docs-processor.js.map

package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAGrE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,uCAQC"}

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts

@@ -0,0 +1,11 @@
+import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { Type } from '@cparra/apex-reflection';
+import { LinkingStrategy } from '../../processor-type-transpiler';
+export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
+    homeFileName(): string;
+    onBeforeProcess: (types: Type[]) => void;
+    onProcess(type: Type): void;
+    get frontMatterForHomeFile(): string;
+    getFrontMatterHeader(type: Type): string;
+    getLinkingStrategy(): LinkingStrategy;
+}

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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JekyllDocsProcessor = void 0;
+const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
+const markdown_home_file_1 = require("../../../model/markdown-home-file");
+const markdown_type_file_1 = require("../../../model/markdown-type-file");
+const settings_1 = require("../../../settings");
+class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
+    constructor() {
+        super(...arguments);
+        this.onBeforeProcess = (types) => {
+            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
+        };
+    }
+    homeFileName() {
+        return 'index';
+    }
+    onProcess(type) {
+        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
+    }
+    get frontMatterForHomeFile() {
+        return '---\nlayout: default\n---';
+    }
+    getFrontMatterHeader(type) {
+        var _a;
+        const headerLines = ['---'];
+        // "layout: default" is a required front matter header for Jekyll
+        headerLines.push('layout: default');
+        // Add any additional front matter headers that might have been configured in the settings
+        const targetType = {
+            name: type.name,
+            typeName: type.type_name,
+            accessModifier: type.access_modifier,
+            group: type.group,
+            description: (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description,
+        };
+        const configuredHeaders = settings_1.Settings.getInstance().frontMatterHeader(targetType);
+        if (configuredHeaders) {
+            configuredHeaders.forEach((header) => {
+                headerLines.push(header);
+            });
+        }
+        headerLines.push('---');
+        return headerLines.join('\n');
+    }
+    getLinkingStrategy() {
+        return 'path-relative';
+    }
+}
+exports.JekyllDocsProcessor = JekyllDocsProcessor;
+//# sourceMappingURL=jekyll-docsProcessor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAErE,gDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAC;IAmCJ,CAAC;IAzCC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,oBAAoB,CAAC,IAAU;;QAC7B,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,iEAAiE;QACjE,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,0FAA0F;QAC1F,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC;QACF,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,iBAAiB,EAAE;YACrB,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACnC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;SACJ;QACD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AA1CD,kDA0CC"}