@cparra/apexdocs 2.23.0 → 2.24.0

package/lib/model/manifest-diff.d.ts

@@ -1,27 +1,27 @@
-import Manifest from './manifest';
-import { Type } from '@cparra/apex-reflection';
-import { Annotation } from '@cparra/apex-reflection/index';
-export declare class ManifestDiff {
-    added: Type[];
-    deleted: Type[];
-    changes: DiffChange[];
-    static build(originalManifest: Manifest, newManifest: Manifest): ManifestDiff;
-}
-declare class DiffChange {
-    originalType: Type;
-    newType: Type;
-    accessModifierChange?: AccessModifierChange;
-    annotationChanges: AnnotationChange[];
-    constructor(originalType: Type, newType: Type);
-    hasChanges(): boolean;
-    private parse;
-}
-interface AccessModifierChange {
-    oldAccessModifier: string;
-    newAccessModifier: string;
-}
-interface AnnotationChange {
-    annotation: Annotation;
-    type: 'added' | 'removed';
-}
-export {};
+import Manifest from './manifest';
+import { Type } from '@cparra/apex-reflection';
+import { Annotation } from '@cparra/apex-reflection/index';
+export declare class ManifestDiff {
+    added: Type[];
+    deleted: Type[];
+    changes: DiffChange[];
+    static build(originalManifest: Manifest, newManifest: Manifest): ManifestDiff;
+}
+declare class DiffChange {
+    originalType: Type;
+    newType: Type;
+    accessModifierChange?: AccessModifierChange;
+    annotationChanges: AnnotationChange[];
+    constructor(originalType: Type, newType: Type);
+    hasChanges(): boolean;
+    private parse;
+}
+interface AccessModifierChange {
+    oldAccessModifier: string;
+    newAccessModifier: string;
+}
+interface AnnotationChange {
+    annotation: Annotation;
+    type: 'added' | 'removed';
+}
+export {};

package/lib/model/manifest-diff.js

@@ -1,69 +1,69 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ManifestDiff = void 0;
-class ManifestDiff {
-    constructor() {
-        this.added = [];
-        this.deleted = [];
-        this.changes = [];
-    }
-    static build(originalManifest, newManifest) {
-        const addedTypes = newManifest.types.filter((currentType) => !originalManifest.types.find((originalType) => currentType.name === originalType.name));
-        const deletedTypes = originalManifest.types.filter((currentType) => !newManifest.types.find((newType) => currentType.name === newType.name));
-        const changes = [];
-        for (const newType of newManifest.types) {
-            const oldType = originalManifest.types.find((oldType) => oldType.name === newType.name);
-            if (!oldType) {
-                continue;
-            }
-            const change = new DiffChange(oldType, newType);
-            if (change.hasChanges()) {
-                changes.push(change);
-            }
-        }
-        const diff = new ManifestDiff();
-        diff.added = addedTypes;
-        diff.deleted = deletedTypes;
-        diff.changes = changes;
-        return diff;
-    }
-}
-exports.ManifestDiff = ManifestDiff;
-class DiffChange {
-    constructor(originalType, newType) {
-        this.originalType = originalType;
-        this.newType = newType;
-        this.annotationChanges = [];
-        this.parse();
-    }
-    hasChanges() {
-        return !!this.accessModifierChange || this.annotationChanges.length > 0;
-    }
-    parse() {
-        // Access modifier changes
-        if (this.originalType.access_modifier !== this.newType.access_modifier) {
-            this.accessModifierChange = {
-                oldAccessModifier: this.originalType.access_modifier,
-                newAccessModifier: this.newType.access_modifier,
-            };
-        }
-        // Annotation changes
-        const addedAnnotations = this.newType.annotations.filter((currentAnnotation) => !this.originalType.annotations.find((originalAnnotation) => currentAnnotation.name === originalAnnotation.name));
-        const removedAnnotations = this.originalType.annotations.filter((currentAnnotation) => !this.newType.annotations.find((newAnnotation) => currentAnnotation.name === newAnnotation.name));
-        const annotationChangeMapper = (annotation, changeType) => {
-            return {
-                annotation: annotation,
-                type: changeType,
-            };
-        };
-        this.annotationChanges = [
-            ...addedAnnotations.map((annotation) => {
-                return annotationChangeMapper(annotation, 'added');
-            }),
-            ...removedAnnotations.map((annotation) => {
-                return annotationChangeMapper(annotation, 'removed');
-            }),
-        ];
-    }
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestDiff = void 0;
+class ManifestDiff {
+    constructor() {
+        this.added = [];
+        this.deleted = [];
+        this.changes = [];
+    }
+    static build(originalManifest, newManifest) {
+        const addedTypes = newManifest.types.filter((currentType) => !originalManifest.types.find((originalType) => currentType.name === originalType.name));
+        const deletedTypes = originalManifest.types.filter((currentType) => !newManifest.types.find((newType) => currentType.name === newType.name));
+        const changes = [];
+        for (const newType of newManifest.types) {
+            const oldType = originalManifest.types.find((oldType) => oldType.name === newType.name);
+            if (!oldType) {
+                continue;
+            }
+            const change = new DiffChange(oldType, newType);
+            if (change.hasChanges()) {
+                changes.push(change);
+            }
+        }
+        const diff = new ManifestDiff();
+        diff.added = addedTypes;
+        diff.deleted = deletedTypes;
+        diff.changes = changes;
+        return diff;
+    }
+}
+exports.ManifestDiff = ManifestDiff;
+class DiffChange {
+    constructor(originalType, newType) {
+        this.originalType = originalType;
+        this.newType = newType;
+        this.annotationChanges = [];
+        this.parse();
+    }
+    hasChanges() {
+        return !!this.accessModifierChange || this.annotationChanges.length > 0;
+    }
+    parse() {
+        // Access modifier changes
+        if (this.originalType.access_modifier !== this.newType.access_modifier) {
+            this.accessModifierChange = {
+                oldAccessModifier: this.originalType.access_modifier,
+                newAccessModifier: this.newType.access_modifier,
+            };
+        }
+        // Annotation changes
+        const addedAnnotations = this.newType.annotations.filter((currentAnnotation) => !this.originalType.annotations.find((originalAnnotation) => currentAnnotation.name === originalAnnotation.name));
+        const removedAnnotations = this.originalType.annotations.filter((currentAnnotation) => !this.newType.annotations.find((newAnnotation) => currentAnnotation.name === newAnnotation.name));
+        const annotationChangeMapper = (annotation, changeType) => {
+            return {
+                annotation: annotation,
+                type: changeType,
+            };
+        };
+        this.annotationChanges = [
+            ...addedAnnotations.map((annotation) => {
+                return annotationChangeMapper(annotation, 'added');
+            }),
+            ...removedAnnotations.map((annotation) => {
+                return annotationChangeMapper(annotation, 'removed');
+            }),
+        ];
+    }
+}
 //# sourceMappingURL=manifest-diff.js.map

package/lib/model/manifest.d.ts

@@ -1,22 +1,22 @@
-import { Type, Annotation, DocComment } from '@cparra/apex-reflection';
-type AccessAndDocAware = {
-    access_modifier: string;
-    annotations: Annotation[];
-    docComment?: DocComment;
-};
-/**
- * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
- */
-export default class Manifest {
-    types: Type[];
-    isForInnerTypes: boolean;
-    /**
-     * Constructs a new Manifest object.
-     * @param types List of types to be wrapped by this object.
-     * @param isForInnerTypes Whether this manifest represent an inner type or not.
-     */
-    constructor(types: Type[], isForInnerTypes?: boolean);
-    filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
-    filterAccessibleModifier(accessAndDocAwares: AccessAndDocAware[], modifiers: string[]): AccessAndDocAware[];
-}
-export {};
+import { Type, Annotation, DocComment } from '@cparra/apex-reflection';
+type AccessAndDocAware = {
+    access_modifier: string;
+    annotations: Annotation[];
+    docComment?: DocComment;
+};
+/**
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
+ */
+export default class Manifest {
+    types: Type[];
+    isForInnerTypes: boolean;
+    /**
+     * Constructs a new Manifest object.
+     * @param types List of types to be wrapped by this object.
+     * @param isForInnerTypes Whether this manifest represent an inner type or not.
+     */
+    constructor(types: Type[], isForInnerTypes?: boolean);
+    filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
+    filterAccessibleModifier(accessAndDocAwares: AccessAndDocAware[], modifiers: string[]): AccessAndDocAware[];
+}
+export {};

package/lib/model/manifest.js

@@ -1,47 +1,47 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
- */
-class Manifest {
-    /**
-     * Constructs a new Manifest object.
-     * @param types List of types to be wrapped by this object.
-     * @param isForInnerTypes Whether this manifest represent an inner type or not.
-     */
-    constructor(types, isForInnerTypes = false) {
-        this.types = types;
-        this.isForInnerTypes = isForInnerTypes;
-    }
-    filteredByAccessModifierAndAnnotations(modifiers) {
-        const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
-        const typesToReturn = [];
-        for (const filteredType of filteredTypes) {
-            const currentType = filteredType;
-            if (currentType.type_name !== 'class') {
-                typesToReturn.push(currentType);
-                continue;
-            }
-            const currentClass = currentType;
-            let filteredClass = Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentClass.methods, modifiers), properties: this.filterAccessibleModifier(currentClass.properties, modifiers), fields: this.filterAccessibleModifier(currentClass.fields, modifiers), constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers) });
-            if (!this.isForInnerTypes) {
-                filteredClass = Object.assign(Object.assign({}, filteredClass), { enums: this.filterAccessibleModifier(currentClass.enums, modifiers), interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers), classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(modifiers) });
-            }
-            typesToReturn.push(filteredClass);
-        }
-        return typesToReturn;
-    }
-    filterAccessibleModifier(accessAndDocAwares, modifiers) {
-        return accessAndDocAwares.filter((currentType) => {
-            var _a;
-            const hasIgnoreDocAnnotation = (_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name === 'ignore');
-            if (hasIgnoreDocAnnotation) {
-                return false;
-            }
-            return (modifiers.includes(currentType.access_modifier) ||
-                currentType.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase())));
-        });
-    }
-}
-exports.default = Manifest;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
+ */
+class Manifest {
+    /**
+     * Constructs a new Manifest object.
+     * @param types List of types to be wrapped by this object.
+     * @param isForInnerTypes Whether this manifest represent an inner type or not.
+     */
+    constructor(types, isForInnerTypes = false) {
+        this.types = types;
+        this.isForInnerTypes = isForInnerTypes;
+    }
+    filteredByAccessModifierAndAnnotations(modifiers) {
+        const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
+        const typesToReturn = [];
+        for (const filteredType of filteredTypes) {
+            const currentType = filteredType;
+            if (currentType.type_name !== 'class') {
+                typesToReturn.push(currentType);
+                continue;
+            }
+            const currentClass = currentType;
+            let filteredClass = Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentClass.methods, modifiers), properties: this.filterAccessibleModifier(currentClass.properties, modifiers), fields: this.filterAccessibleModifier(currentClass.fields, modifiers), constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers) });
+            if (!this.isForInnerTypes) {
+                filteredClass = Object.assign(Object.assign({}, filteredClass), { enums: this.filterAccessibleModifier(currentClass.enums, modifiers), interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers), classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(modifiers) });
+            }
+            typesToReturn.push(filteredClass);
+        }
+        return typesToReturn;
+    }
+    filterAccessibleModifier(accessAndDocAwares, modifiers) {
+        return accessAndDocAwares.filter((currentType) => {
+            var _a;
+            const hasIgnoreDocAnnotation = (_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name === 'ignore');
+            if (hasIgnoreDocAnnotation) {
+                return false;
+            }
+            return (modifiers.includes(currentType.access_modifier) ||
+                currentType.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase())));
+        });
+    }
+}
+exports.default = Manifest;
 //# sourceMappingURL=manifest.js.map

package/lib/model/markdown-file.d.ts

@@ -1,16 +1,16 @@
-import { OutputFile } from './outputFile';
-export declare class MarkdownFile extends OutputFile {
-    fileExtension(): string;
-    addTitle(text: string, level?: number): void;
-    addText(text: string, encodeHtml?: boolean): void;
-    addLink(text: string, encodeHtml?: boolean): void;
-    startCodeBlock(language?: string): void;
-    endCodeBlock(): void;
-    addHorizontalRule(): void;
-    initializeTable(...headers: string[]): void;
-    addTableRow(...columns: string[]): void;
-    addListItem(text: string): void;
-    protected static replaceInlineLinks(text: string): string;
-    protected static replaceInlineEmails(text: string): string;
-    private _replaceInlineReferences;
-}
+import { OutputFile } from './outputFile';
+export declare class MarkdownFile extends OutputFile {
+    fileExtension(): string;
+    addTitle(text: string, level?: number): void;
+    addText(text: string, encodeHtml?: boolean): void;
+    addLink(text: string, encodeHtml?: boolean): void;
+    startCodeBlock(language?: string): void;
+    endCodeBlock(): void;
+    addHorizontalRule(): void;
+    initializeTable(...headers: string[]): void;
+    addTableRow(...columns: string[]): void;
+    addListItem(text: string): void;
+    protected static replaceInlineLinks(text: string): string;
+    protected static replaceInlineEmails(text: string): string;
+    private _replaceInlineReferences;
+}

package/lib/model/markdown-file.js

@@ -1,107 +1,107 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MarkdownFile = void 0;
-const outputFile_1 = require("./outputFile");
-const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
-class MarkdownFile extends outputFile_1.OutputFile {
-    fileExtension() {
-        return '.md';
-    }
-    addTitle(text, level = 1) {
-        let title = '';
-        for (let i = 0; i < level; i++) {
-            title += '#';
-        }
-        title += ' ';
-        title += text;
-        this._contents += title;
-        this.addBlankLine();
-    }
-    addText(text, encodeHtml = true) {
-        super.addText(this._replaceInlineReferences(text), encodeHtml);
-    }
-    addLink(text, encodeHtml = true) {
-        this.addText(`\{@link ${text}\}`, encodeHtml);
-    }
-    startCodeBlock(language = 'apex') {
-        this.addText(`\`\`\`${language}`);
-    }
-    endCodeBlock() {
-        this.addText('```');
-        this.addBlankLine();
-    }
-    addHorizontalRule() {
-        this._contents += '---';
-        this.addBlankLine();
-    }
-    initializeTable(...headers) {
-        this.addBlankLine();
-        this._contents += '|';
-        headers.forEach((header) => {
-            this._contents += header + '|';
-        });
-        this.addBlankLine();
-        this._contents += '|';
-        headers.forEach((_) => {
-            this._contents += '---' + '|';
-        });
-        this.addBlankLine();
-    }
-    addTableRow(...columns) {
-        this._contents += '|';
-        columns.forEach((column) => {
-            this._contents += this._replaceInlineReferences(column) + '|';
-        });
-        this.addBlankLine();
-    }
-    addListItem(text) {
-        this._contents += `* ${text}`;
-    }
-    static replaceInlineLinks(text) {
-        // Parsing text to extract possible linking classes.
-        const possibleLinks = text.match(/<<.*?>>/g);
-        possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
-            const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
-            text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
-        });
-        // Parsing links using {@link ClassName} format
-        const linkFormatRegEx = '{@link (.*?)}';
-        const expression = new RegExp(linkFormatRegEx, 'gi');
-        let match;
-        const matches = [];
-        do {
-            match = expression.exec(text);
-            if (match) {
-                matches.push(match);
-            }
-        } while (match);
-        for (const currentMatch of matches) {
-            text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
-        }
-        return text;
-    }
-    static replaceInlineEmails(text) {
-        // Parsing links using {@link ClassName} format
-        const linkFormatRegEx = '{@email (.*?)}';
-        const expression = new RegExp(linkFormatRegEx, 'gi');
-        let match;
-        const matches = [];
-        do {
-            match = expression.exec(text);
-            if (match) {
-                matches.push(match);
-            }
-        } while (match);
-        for (const currentMatch of matches) {
-            text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
-        }
-        return text;
-    }
-    _replaceInlineReferences(text) {
-        text = MarkdownFile.replaceInlineLinks(text);
-        text = MarkdownFile.replaceInlineEmails(text);
-        return text;
-    }
-}
-exports.MarkdownFile = MarkdownFile;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownFile = void 0;
+const outputFile_1 = require("./outputFile");
+const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
+class MarkdownFile extends outputFile_1.OutputFile {
+    fileExtension() {
+        return '.md';
+    }
+    addTitle(text, level = 1) {
+        let title = '';
+        for (let i = 0; i < level; i++) {
+            title += '#';
+        }
+        title += ' ';
+        title += text;
+        this._contents += title;
+        this.addBlankLine();
+    }
+    addText(text, encodeHtml = true) {
+        super.addText(this._replaceInlineReferences(text), encodeHtml);
+    }
+    addLink(text, encodeHtml = true) {
+        this.addText(`\{@link ${text}\}`, encodeHtml);
+    }
+    startCodeBlock(language = 'apex') {
+        this.addText(`\`\`\`${language}`);
+    }
+    endCodeBlock() {
+        this.addText('```');
+        this.addBlankLine();
+    }
+    addHorizontalRule() {
+        this._contents += '---';
+        this.addBlankLine();
+    }
+    initializeTable(...headers) {
+        this.addBlankLine();
+        this._contents += '|';
+        headers.forEach((header) => {
+            this._contents += header + '|';
+        });
+        this.addBlankLine();
+        this._contents += '|';
+        headers.forEach((_) => {
+            this._contents += '---' + '|';
+        });
+        this.addBlankLine();
+    }
+    addTableRow(...columns) {
+        this._contents += '|';
+        columns.forEach((column) => {
+            this._contents += this._replaceInlineReferences(column) + '|';
+        });
+        this.addBlankLine();
+    }
+    addListItem(text) {
+        this._contents += `* ${text}`;
+    }
+    static replaceInlineLinks(text) {
+        // Parsing text to extract possible linking classes.
+        const possibleLinks = text.match(/<<.*?>>/g);
+        possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
+            const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
+            text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
+        });
+        // Parsing links using {@link ClassName} format
+        const linkFormatRegEx = '{@link (.*?)}';
+        const expression = new RegExp(linkFormatRegEx, 'gi');
+        let match;
+        const matches = [];
+        do {
+            match = expression.exec(text);
+            if (match) {
+                matches.push(match);
+            }
+        } while (match);
+        for (const currentMatch of matches) {
+            text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
+        }
+        return text;
+    }
+    static replaceInlineEmails(text) {
+        // Parsing links using {@link ClassName} format
+        const linkFormatRegEx = '{@email (.*?)}';
+        const expression = new RegExp(linkFormatRegEx, 'gi');
+        let match;
+        const matches = [];
+        do {
+            match = expression.exec(text);
+            if (match) {
+                matches.push(match);
+            }
+        } while (match);
+        for (const currentMatch of matches) {
+            text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
+        }
+        return text;
+    }
+    _replaceInlineReferences(text) {
+        text = MarkdownFile.replaceInlineLinks(text);
+        text = MarkdownFile.replaceInlineEmails(text);
+        return text;
+    }
+}
+exports.MarkdownFile = MarkdownFile;
 //# sourceMappingURL=markdown-file.js.map

package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts

@@ -1,8 +1,8 @@
-import { DocComment } from '@cparra/apex-reflection';
-import { MarkdownFile } from '../markdown-file';
-interface DocCommentAware {
-    docComment?: DocComment;
-}
-export declare function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
-export declare function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
-export {};
+import { DocComment } from '@cparra/apex-reflection';
+import { MarkdownFile } from '../markdown-file';
+interface DocCommentAware {
+    docComment?: DocComment;
+}
+export declare function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
+export declare function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
+export {};