@cparra/apexdocs 2.22.0 → 2.23.0

package/lib/test-helpers/DocCommentBuilder.js

@@ -1,38 +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;
+"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/FieldMirrorBuilder.d.ts

@@ -1,18 +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 {};
+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

@@ -1,54 +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;
+"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/MethodMirrorBuilder.d.ts

@@ -1,10 +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;
-}
+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

@@ -1,37 +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;
+"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/SettingsBuilder.d.ts

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

@@ -1,27 +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;
+"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/transpiler/factory.d.ts

@@ -1,6 +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;
-}
+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

@@ -1,32 +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;
+"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/file-container.d.ts

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

package/lib/transpiler/file-container.js

@@ -1,16 +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;
+"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/generator-choices.d.ts

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

package/lib/transpiler/generator-choices.js

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

package/lib/transpiler/markdown/class-file-generatorHelper.d.ts

@@ -1,8 +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;
-}
+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

@@ -1,56 +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;
+"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