@terafina/tffa-sfdx-plugin 17.0.0-rc.9 → 18.0.0-rc.1

package/lib/services/apexdoc/common/models/property-model.d.ts

@@ -1,12 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { ApexModel } from './apex-model';
-import { Option } from '../..';
-declare class PropertyModel extends ApexModel {
-    constructor(comments: string[], nameLine: string, lineNum: number, sourceUrl: Option<string>);
-    get name(): string;
-    get type(): string;
-    protected setNameLine(nameLine: string, lineNum: number): void;
-}
-export { PropertyModel };

package/lib/services/apexdoc/common/models/top-level-model.d.ts

@@ -1,19 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { ApexModel } from './apex-model';
-import { Option } from '../..';
-export declare enum ModelType {
-    CLASS = 0,
-    ENUM = 1
-}
-declare abstract class TopLevelModel extends ApexModel {
-    protected _modelType: ModelType;
-    constructor(comments: string[], modelType: ModelType, sourceUrl: Option<string>);
-    abstract get groupName(): string;
-    get author(): string;
-    get since(): string;
-    get groupContentPath(): string;
-    get modelType(): ModelType;
-}
-export { TopLevelModel };

package/lib/services/apexdoc/common/settings.d.ts

@@ -1,56 +0,0 @@
-import { IDocblockConfig, IEngineConfig } from '..';
-export declare enum Feature {
-    ENGINE = 0,
-    DOC_BLOCK = 1
-}
-declare class Settings {
-    private static projectRoot;
-    static config: IEngineConfig;
-    static readonly SCOPES: string[];
-    static readonly GROUPS: string[];
-    static readonly ORDER_ALPHA: string;
-    static readonly ORDER_LOGICAL: string;
-    static readonly CLASS: string;
-    static readonly ENUM: string;
-    static readonly INTERFACE: string;
-    static readonly DOC_BLOCK_BREAK: string;
-    static readonly COMMENT_CLOSE: string;
-    static readonly COMMENT_OPEN: string;
-    /**
-     * Note that casting user provided configs as ApexDox configs
-     * can potentially result in run-time errors. The onus is on
-     * the user to ensure the correct shape of their config files,
-     * however, the app should fail loudly and gracefully if the
-     * user provides an invalid config.
-     */
-    private static getRcFile;
-    /**
-     * Get user's ApexDox config and set defaults where needed.
-     * Order of preference for config files is listed below. If more than one
-     * config file is present, this is the order that will be honored by ApexDox.
-     *
-     *  3. .apexdoxrc
-     *
-     */
-    static getConfig<T extends IEngineConfig | IDocblockConfig>(type: Feature, sourceFolder: string, destfolder: string): T;
-    /**
-     * Source and Target Dir default settings are dynamic and determined at runtime. If user
-     * omits these settings or provides invalid values, overwrite with default settings.
-     * @param config The `IEngineConfig` instance fetched from the user's settings.json or .apexdoxrc file.
-     */
-    private static setEngineDirectoryDefaults;
-    /**
-     * Get the default source directory based on the type of project.
-     *
-     * @param projectRoot The workspace's root folder.
-     */
-    private static getDefaultDir;
-    /**
-     * Determine with reasonable certainty whether this is a DX project or not.
-     * This will help us determine what the default source directory should be.
-     *
-     * @param projectRoot The workspace's root folder.
-     */
-    private static isDX;
-}
-export default Settings;

package/lib/services/apexdoc/common/tags.d.ts

@@ -1,22 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { IApexDoxTag } from '..';
-export declare const AUTHOR: IApexDoxTag;
-export declare const SINCE: IApexDoxTag;
-export declare const DEPRECATED: IApexDoxTag;
-export declare const DESCRIPTION: IApexDoxTag;
-export declare const EXAMPLE: IApexDoxTag;
-export declare const EXCEPTION: IApexDoxTag;
-export declare const GROUP: IApexDoxTag;
-export declare const TAGS: IApexDoxTag;
-export declare const GROUP_CONTENT: IApexDoxTag;
-export declare const PARAM: IApexDoxTag;
-export declare const QUERYPARAM: IApexDoxTag;
-export declare const RETURN: IApexDoxTag;
-export declare const RETURNS: IApexDoxTag;
-export declare const SEE: IApexDoxTag;
-export declare const APIPATH: IApexDoxTag;
-export declare const APIMETHOD: IApexDoxTag;
-export declare const REQUESTHEADER: IApexDoxTag;
-export declare const RESPONSEHEADER: IApexDoxTag;

package/lib/services/apexdoc/common/utils.d.ts

@@ -1,39 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { ClassModel } from './models/class-model';
-import { Option } from '..';
-declare class Utils {
-    private static readonly PRIVATE;
-    private static readonly TEST_METHOD;
-    private static COLLECTIONS;
-    private static KEYWORDS;
-    static isClassOrInterface(line: string): boolean;
-    static isEnum(line: string): boolean;
-    static stripAnnotations(line: string): string;
-    /**
-     * Helper method to determine if a line being parsed should be skipped.
-     * Ignore lines not dealing with scope unless they start with the certain keywords:
-     * We do not want to skip @isTest classes, inner classes, inner interfaces, or inner
-     * enums defined without without explicit access modifiers. These are assumed to be
-     * private. Also, interface methods don't have scope, so don't skip those lines either.
-     */
-    static shouldSkipLine(line: string, cModel?: ClassModel): boolean;
-    /** Can match some implicitly private methods, but not all! */
-    static getScope(line: string): Option<string, void>;
-    static previousWord(str: string, searchIdx: number): string;
-    static countChars(str: string, char: string): number;
-    static isURL(str: string): boolean;
-    static resolveWorkspaceFolder(path: string): string;
-    static resolveWorkspaceFolder2(path: string, sourceFolder: string): string;
-    static escapeRegExp(str: string): string;
-    static boolGuard(bool: boolean, defaultValue: boolean): boolean;
-    /**
-     * We use the plugin `pretty` to make the output HTML more readable. As a side effect
-     * there is whitespace between the pre and code tags which causes unwanted space in the HTML
-     * document. Here, we're removing that space so pre and code tags do not have space between them.
-     * @param html The html string to make replacements on.
-     */
-    static preCodeTrim(html: string): string;
-}
-export default Utils;

package/lib/services/apexdoc/common/validator-engine.d.ts

@@ -1,23 +0,0 @@
-import Validator from './validator';
-import { IEngineConfig } from '../index';
-declare class ValidatorEngine extends Validator<IEngineConfig> {
-    constructor(config: IEngineConfig);
-    private includes;
-    private excludes;
-    private cleanDir;
-    private showTOCSnippets;
-    private subtitle;
-    private pages;
-    private assets;
-    private targetDirectory;
-    private homePagePath;
-    private sortOrder;
-    private title;
-    private scope;
-    static port(port: number): number;
-    private static directory;
-    private static sourceUrl;
-    private static stringArray;
-    private static typeGuard;
-}
-export default ValidatorEngine;

package/lib/services/apexdoc/common/validator.d.ts

@@ -1,16 +0,0 @@
-declare abstract class Validator<T> {
-    protected config: T;
-    [key: string]: any;
-    protected currentFields: string[];
-    protected validFields: string[];
-    constructor(config: T);
-    /**
-     * Since we're allowing rc and yaml config files (e.g. losing helpful intellisense)
-     * we need to carefully validate configs coming in. This method will match each config
-     * key to an instance method which validates that key. For engine configs, the 'port'
-     * setting is the exception which will be validated only at serveDocs runtime. This
-     * will also throw an error if any unexpected, rogue configuration settings are found.
-     */
-    validate(): T;
-}
-export default Validator;

package/lib/services/apexdoc/engine/file-manager.d.ts

@@ -1,52 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import * as Models from '../common/models';
-import { ISourceEntry, Option, IApexDoxMenus } from '..';
-declare class FileManager {
-    private path;
-    private projectTitle;
-    private userAssets;
-    constructor(targetDirectory: string, projectTitle: string, assets: string[]);
-    /**
-     * Collects the Apex .cls files the user has indicated they'd like to document via config settings.
-     *
-     * @param sources A list of `ISourceEntry` objects from where to collect our .cls files
-     * @param includes See config settings: a list of patterns to include
-     * @param excludes See config settings: a list of patterns to exclude
-     */
-    getFiles(sources: ISourceEntry[], includes: string[], excludes: string[]): ISourceEntry[];
-    /**
-     * Main routine that creates HTML file for each of our classes and for any additional
-     * pages that a user has included, e.g. home page, class group, supplementary.
-     *
-     * @param groupNameMap Map of our class group names to their ClassGroup instances
-     * @param models Map of our model names to their TopLevelModel instances
-     * @param pages Any additional pages, including the project home page, the user has included
-     */
-    createDocs(groupNameMap: Map<string, Models.ClassGroup>, models: Map<string, Models.TopLevelModel>, pages: string[]): void;
-    /**
-     * Parses HTML files provided by the user, like class group pages,
-     * and the project home page. Returns any content between
-     * the <body> tags, or the entire markup if no <body> tags are present.
-     * The extracted markup will be placed within the project's standard
-     * page layout (header, menu, footer) for the final product.
-     *
-     * @param filePath The path of the HTML file to parse.
-     * @returns string representing the markup or void.
-     */
-    parseHTMLFile(filePath: string): Option<string, void>;
-    private makeDirs;
-    private createHTMLFiles;
-    private createSearchIndex;
-    private collectApexDoxAssets;
-    private copyAssetsToTarget;
-    private makePage;
-    makeMenuItems(models: Map<string, Models.TopLevelModel>): void;
-    makeRestDefinition(models: Map<string, Models.TopLevelModel>): void;
-    mapToObj(inputMap: Map<string, any>): unknown;
-    makeDocumentationPages(fileMap: Map<string, string>, menus: IApexDoxMenus, models: Map<string, Models.TopLevelModel>): void;
-    private makeSupplementaryPages;
-    private makeClassGroupPages;
-}
-export default FileManager;

package/lib/services/apexdoc/engine/generators/generator-utils.d.ts

@@ -1,12 +0,0 @@
-import { TopLevelModel } from '../../common/models';
-declare class GeneratorUtils {
-    static mapHTML<T>(arr: T[], mapClb: (val: T) => string): string;
-    static encodeText(str: string, convertBackticksToCode?: boolean, models?: Map<string, TopLevelModel>): string;
-    static resolveInlineLinks(str: string, models: Map<string, TopLevelModel>): string;
-    private static wrapWithCode;
-    static makeHead(documentTitle: string): string;
-    static makeProjectSplash(): string;
-    static get footer(): string;
-    static get defaultHomePage(): string;
-}
-export default GeneratorUtils;

package/lib/services/apexdoc/engine/generators/menu-generator.d.ts

@@ -1,9 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import * as Models from '../../common/models';
-declare class MenuGenerator {
-    static makeScopeMenu(): string;
-    static makeMenu(classGroupMap: Map<string, Models.ClassGroup>, models: Map<string, Models.TopLevelModel>): string;
-}
-export default MenuGenerator;

package/lib/services/apexdoc/engine/generators/models/child-enum-markup-generator.d.ts

@@ -1,10 +0,0 @@
-import MarkupGenerator from './markup-generator';
-import { ClassModel, EnumModel, TopLevelModel } from '../../../common/models';
-declare class ChildEnumMarkupGenerator extends MarkupGenerator<EnumModel> {
-    constructor(model: EnumModel, models: Map<string, TopLevelModel>);
-    static generate(cModel: ClassModel, models: Map<string, TopLevelModel>): string;
-    protected static hasDescriptionColumn(headerRow: string): boolean;
-    protected static headerRow(enums: Array<EnumModel>): string;
-    protected enumRow(topmostTypeName: string, hasDescriptionColumn: boolean): string;
-}
-export default ChildEnumMarkupGenerator;

package/lib/services/apexdoc/engine/generators/models/class-markup-generator.d.ts

@@ -1,8 +0,0 @@
-import MarkupGenerator from './markup-generator';
-import { ClassModel, TopLevelModel } from '../../../common/models';
-declare class ClassMarkupGenerator extends MarkupGenerator<ClassModel> {
-    protected constructor(model: ClassModel, models: Map<string, TopLevelModel>);
-    static generate(cModel: ClassModel, models: Map<string, TopLevelModel>): string;
-    protected header(topmostTypeName: string): string;
-}
-export default ClassMarkupGenerator;

package/lib/services/apexdoc/engine/generators/models/enum-markup-generator.d.ts

@@ -1,9 +0,0 @@
-import MarkupGenerator from './markup-generator';
-import { EnumModel, TopLevelModel } from '../../../common/models';
-declare class EnumMarkupGenerator extends MarkupGenerator<EnumModel> {
-    protected constructor(model: EnumModel, models: Map<string, TopLevelModel>);
-    static generate(eModel: EnumModel, models: Map<string, TopLevelModel>): string;
-    protected header(topmostTypeName: string): string;
-    protected valuesTable(): string;
-}
-export default EnumMarkupGenerator;

package/lib/services/apexdoc/engine/generators/models/markup-generator.d.ts

@@ -1,27 +0,0 @@
-import { ApexModel, TopLevelModel } from '../../../common/models';
-/**
- * This class is the base markup generation class and is not instantiated directly. It
- * includes markup generation methods that are common to all ApexModels, and some that
- * are common only to TopLevelModel and MethodModel, so be careful when calling these
- * methods that they correctly correspond to the model you are generating markup for.
- */
-declare abstract class MarkupGenerator<T extends ApexModel> {
-    protected model: T;
-    protected models: Map<string, TopLevelModel>;
-    protected constructor(model: T, models: Map<string, TopLevelModel>);
-    protected markupTemplate(label: string, contents: string, titleClass?: string, contentClass?: string, tag?: string): string;
-    protected annotations(className: string): string;
-    protected deprecated(): string;
-    protected description(className?: string, tag?: string, override?: boolean): string;
-    protected example(): string;
-    protected api(): string;
-    protected see(): string;
-    protected signature(signatureType: 'method' | 'class'): string;
-    protected linkToSource(nameOrSignature: string, topmostTypeName: string, highlightJSify?: boolean): string;
-    /**
-     * Help highlight.js along, since props and enum signatures are not
-     * recognized by highlight.js since they are not full declarations.
-     */
-    protected highlightSignature(nameLine: string): string;
-}
-export default MarkupGenerator;

package/lib/services/apexdoc/engine/generators/models/method-markup-generator.d.ts

@@ -1,22 +0,0 @@
-import MarkupGenerator from './markup-generator';
-import { ClassModel, MethodModel, TopLevelModel } from '../../../common/models';
-declare class MethodMarkupGenerator extends MarkupGenerator<MethodModel> {
-    protected constructor(model: MethodModel, models: Map<string, TopLevelModel>);
-    static generate(cModel: ClassModel, models: Map<string, TopLevelModel>): string;
-    private static generateSection;
-    protected markupTemplate(label: string, contents: string, titleClass?: string, contentClass?: string, tag?: string): string;
-    protected author(): string;
-    protected header(id: string, topmostTypeName: string): string;
-    protected since(): string;
-    protected exception(): string;
-    protected params(): string;
-    protected returns(): string;
-    protected getTOCEntry(showTOCSnippets: boolean, id: string): string;
-    /**
-     * See if method ID has been used previously in this class
-     * (must be an overloaded method or constructor) and amend
-     * as needed to ensure all of our methods have unique IDs
-     */
-    protected generateMethodId(idCountMap: Map<string, number>, classModel: ClassModel): string;
-}
-export default MethodMarkupGenerator;

package/lib/services/apexdoc/engine/generators/models/property-markup-generator.d.ts

@@ -1,11 +0,0 @@
-import MarkupGenerator from './markup-generator';
-import { ClassModel, PropertyModel, TopLevelModel } from '../../../common/models';
-declare class PropertyMarkupGenerator extends MarkupGenerator<PropertyModel> {
-    protected constructor(model: PropertyModel, models: Map<string, TopLevelModel>);
-    static generate(cModel: ClassModel, models: Map<string, TopLevelModel>): string;
-    protected static hasDescriptionColumn(headerRow: string): boolean;
-    protected static hasAnnotationsColumn(headerRow: string): boolean;
-    protected static headerRow(properties: Array<PropertyModel>): string;
-    protected propRow(topmostTypeName: string, hasAnnotationsColumn: boolean, hasDescriptionColumn: boolean): string;
-}
-export default PropertyMarkupGenerator;

package/lib/services/apexdoc/engine/generators/models/source-markup-generator.d.ts

@@ -1,10 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import MarkupGenerator from './markup-generator';
-import { TopLevelModel } from '../../../common/models';
-declare class SourceMarkupGenerator extends MarkupGenerator<TopLevelModel> {
-    protected constructor(model: TopLevelModel, models: Map<string, TopLevelModel>);
-    static generate(model: TopLevelModel, models: Map<string, TopLevelModel>): string;
-}
-export default SourceMarkupGenerator;

package/lib/services/apexdoc/engine/generators/models/top-level-markup-generator.d.ts

@@ -1,10 +0,0 @@
-import MarkupGenerator from './markup-generator';
-import { TopLevelModel } from '../../../common/models';
-declare class TopLevelMarkupGenerator extends MarkupGenerator<TopLevelModel> {
-    protected constructor(model: TopLevelModel, models: Map<string, TopLevelModel>);
-    static generate(model: TopLevelModel, models: Map<string, TopLevelModel>, additionalContent?: string): string;
-    protected markupTemplate(label: string, contents: string, titleClass?: string, contentClass?: string, tag?: string): string;
-    protected author(): string;
-    protected since(): string;
-}
-export default TopLevelMarkupGenerator;

package/lib/services/apexdoc/engine/generators/see-link-generator.d.ts

@@ -1,20 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import * as Models from '../../common/models';
-declare class SeeLinkGenerator {
-    private static isMarkdownURL;
-    private static markdownUrlToLink;
-    static makeLinks(models: Map<string, Models.TopLevelModel>, qualifiers: string[]): string[];
-    /**
-     * Search through methods for a match to the provided qualifier. If a match is made
-     * and an overload selector is provided, continue iterating to see if that overload
-     * exists, and match on it if it does. If it does not, report that no match is made.
-     *
-     * @param methods The methods to search for a match through
-     * @param matcher The user provided qualifier to match against a method name
-     * @param overloadSelector The user provided indicator of the method overload number
-     */
-    private static methodMatcher;
-}
-export default SeeLinkGenerator;

package/lib/services/lint/apex-class-scan.d.ts

@@ -1,31 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { Logger } from '@salesforce/core';
-export default class ApexClassScan {
-    dir: string;
-    classFiles: any[];
-    violations: any[];
-    ignoreFiles: any[];
-    logger: Logger;
-    scan(sourceFolder: string): Promise<unknown[]>;
-    scanApexClasses(sourceFolder: string): Promise<any[]>;
-    scanApexTests(sourceFolder: string): Promise<unknown[]>;
-    /**
-     * test file names as per conventions
-     */
-    private checkFileNameConvention;
-    private checkClassesForKeywords2;
-    /**
-     * test class files for filter
-     * @param {*} keywords
-     * @param {*} hint
-     */
-    private checkClassesForKeywords;
-    /**
-     * Using recursion, we find every file with the desired extention, even if its deeply nested in subfolders.
-     * @param {*} dir
-     * @param {*} ext
-     */
-    private getFilesInDirectory;
-}

package/lib/services/lint/apex-pmd.d.ts

@@ -1,10 +0,0 @@
-import { Logger } from '@salesforce/core';
-export default class ApexPMD {
-    ignoreFiles: any[];
-    logger: Logger;
-    rules: string[];
-    eject(sourceFolder: string): Promise<unknown[]>;
-    scan(sourceFolder: string, rulesetpath: string): Promise<any[]>;
-    private executeCmd;
-    private parseProblems;
-}

package/lib/services/lint/eslint-scan.d.ts

@@ -1,13 +0,0 @@
-import { Logger } from '@salesforce/core';
-/**
- * Linter executes the eslint command
- */
-export default class EslintScan {
-    ignoreFiles: any[];
-    logger: Logger;
-    paths: string[];
-    eject(sourceFolder: string): Promise<unknown[]>;
-    scan(sourceFolder: string): Promise<any[]>;
-    private executeCmd;
-    private parseProblems;
-}

package/lib/services/lint/metadata-scan.d.ts

@@ -1,30 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { Logger } from '@salesforce/core';
-export default class MetadataScan {
-    namespace: any;
-    constructor(namespace?: string);
-    ignoreFiles: any[];
-    violations: unknown[];
-    logger: Logger;
-    apiViolations: any[];
-    scan(sourceFolder: string, minapi: number): Promise<unknown[]>;
-    /**
-     * parse objects
-     * @param {*} objpath
-     * @param {*} clientname
-     */
-    private scanObjects;
-    /**
-     * scan api
-     * @param sourceFolder
-     * @param minapi
-     */
-    private scanAPIVersion;
-    private scanAPIVersionByType;
-    /**
-     * scan json files
-     */
-    private scanJSONFiles;
-}

package/lib/services/lint/rules.d.ts

@@ -1,10 +0,0 @@
-interface Rule {
-    category: 'INTERNAL' | 'PMD' | 'ESLINT' | 'API';
-    label: string;
-    message: string;
-    level: 'WARN' | 'FATAL';
-}
-export declare class Rules {
-    static customrules: Record<string, Rule>;
-}
-export {};

package/lib/services/lint/stylelint-scan.d.ts

@@ -1,13 +0,0 @@
-import { Logger } from '@salesforce/core';
-/**
- * Linter executes the stylelint command
- */
-export default class StylelintScan {
-    ignoreFiles: any[];
-    logger: Logger;
-    paths: string[];
-    eject(sourceFolder: string): Promise<unknown[]>;
-    scan(sourceFolder: string): Promise<any[]>;
-    private executeCmd;
-    private parseProblems;
-}

package/lib/services/meta/field-scan.d.ts

@@ -1,23 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { Logger } from '@salesforce/core';
-export default class FieldScan {
-    headers: string[];
-    records: any[];
-    logger: Logger;
-    scan(sourceFolder: string, destPath: string, clientname: string, output: string): Promise<void>;
-    /**
-     * parse objects
-     * @param {*} objpath
-     * @param {*} clientname
-     */
-    private parse;
-    private ensureDirectoryExistence;
-    private getObjectType;
-    /**
-     * write to tmp/cz/objects.csv
-     */
-    private writeCSV;
-    private writeJSON;
-}

package/lib/utils/constants.d.ts

@@ -1,9 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-export declare class Constants {
-    /**
-     * All constants
-     */
-    static API_VERSION: number;
-}

package/lib/utils/ignored-files.d.ts

@@ -1,18 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { Logger } from '@salesforce/core';
-export default class IgnoredFiles {
-    static skipObjects: string[];
-    static skipObjectPrefixes: string;
-    static integrationPrefixes: string;
-    static skipProjects: string[];
-    static skipStandardObjects: string[];
-    static ignoreFiles: string[];
-    static allowedClassNameListEnd: string[];
-    static allowedClassNameListStart: string[];
-    static files: any[];
-    static logger: Logger;
-    static init(sourceFolder: string): Promise<void>;
-    getCurrentWorkingDirectory(): string;
-}

package/lib/utils/jreSetupManager.d.ts

@@ -1,17 +0,0 @@
-import { AsyncCreatable } from '@salesforce/kit';
-export declare class JreSetupManagerDependencies {
-    autoDetectJavaHome(): Promise<string>;
-}
-export declare class JreSetupManager extends AsyncCreatable {
-    private logger;
-    private dependencies;
-    private initialized;
-    protected init(): Promise<void>;
-    verifyJreSetup(): Promise<string>;
-    private findJavaHome;
-    private findJavaHomeFromSysVariables;
-    private autoDetectJavaHome;
-    private verifyJavaVersion;
-    private fetchJavaVersion;
-}
-export declare function verifyJreSetup(): Promise<string>;