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

package/package.json

@@ -1,72 +1,71 @@
 {
   "name": "@terafina/tffa-sfdx-plugin",
   "description": "sfdx plugin from Terafina containing tools for scanning and extending digital applications for the financial services industry.",
-  "version": "17.0.0-rc.9",
+  "version": "18.0.0-rc.1",
   "author": "Terafina Inc",
   "bugs": "https://github.com/terafinainc/tffa-sfdx-plugin/issues",
   "dependencies": {
-    "@oclif/core": "2.0.11",
-    "@oclif/plugin-help": "5.2.4",
-    "@oclif/plugin-plugins": "2.3.0",
-    "@oclif/plugin-version": "1.2.1",
-    "@oclif/plugin-warn-if-update-available": "2.0.26",
-    "@salesforce/command": "5.3.0",
-    "@salesforce/core": "3.33.1",
-    "@salesforce/sf-plugins-core": "2.0.2",
+    "@oclif/core": "2.8.0",
+    "@salesforce/core": "3.34.6",
+    "@oclif/plugin-help": "5.2.9",
+    "@oclif/plugin-plugins": "2.4.4",
+    "@oclif/plugin-version": "1.3.2",
+    "@oclif/plugin-warn-if-update-available": "2.0.33",
+    "@salesforce/sf-plugins-core": "2.2.7",
     "find-java-home": "2.0.0",
     "cheerio": "1.0.0-rc.12",
-    "csv-stringify": "6.2.4",
-    "fs-extra": "11.1.0",
+    "csv-stringify": "6.3.0",
+    "fs-extra": "11.1.1",
     "lodash.escape": "4.0.1",
     "pretty": "2.0.0",
-    "rimraf": "4.1.2",
+    "rimraf": "4.4.1",
     "tslib": "2.5.0",
     "xml2js": "0.4.23",
     "recursive-readdir": "2.2.3",
     "replace-in-file": "6.3.5"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.4.2",
-    "@commitlint/config-angular": "17.4.2",
-    "@oclif/test": "2.3.5",
+    "@commitlint/cli": "17.5.1",
+    "@commitlint/config-angular": "17.4.4",
+    "@oclif/test": "2.3.14",
     "@salesforce/dev-config": "3.1.0",
-    "@salesforce/ts-sinon": "1.4.5",
+    "@salesforce/ts-sinon": "1.4.6",
     "@types/chai": "4",
     "@types/cheerio": "0.22.31",
     "@types/fs-extra": "11.0.1",
     "@types/js-yaml": "4.0.5",
     "@types/mocha": "10.0.1",
-    "@types/node": "18.13.0",
+    "@types/node": "18.15.11",
     "@types/recursive-readdir": "2.2.1",
     "@types/xml2js": "0.4.11",
-    "@typescript-eslint/eslint-plugin": "5.51.0",
-    "@typescript-eslint/parser": "5.51.0",
+    "@typescript-eslint/eslint-plugin": "5.57.1",
+    "@typescript-eslint/parser": "5.57.1",
     "chai": "4",
-    "eslint": "8.33.0",
-    "eslint-config-prettier": "8.6.0",
-    "eslint-plugin-deprecation": "1.3.3",
+    "eslint": "8.37.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-deprecation": "1.4.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-jest": "27.2.1",
-    "eslint-plugin-jsdoc": "39.8.0",
+    "eslint-plugin-jsdoc": "40.1.1",
     "eslint-plugin-prefer-arrow": "1.2.3",
-    "eslint-plugin-sonarjs": "0.18.0",
+    "eslint-plugin-sonarjs": "0.19.0",
     "globby": "11.0.1",
-    "htmlparser2": "8.0.1",
+    "htmlparser2": "8.0.2",
     "husky": "8.0.3",
-    "mem-fs": "2.2.1",
-    "mem-fs-editor": "9.6.0",
+    "mem-fs": "2.3.0",
+    "mem-fs-editor": "9.7.0",
     "mocha": "10.2.0",
     "nyc": "15.1.0",
-    "oclif": "3.6.3",
-    "prettier": "2.8.4",
+    "oclif": "3.7.3",
+    "prettier": "2.8.7",
     "prettier-plugin-apex": "1.12.0",
     "properties-parser": "0.3.1",
     "properties-reader": "2.2.0",
     "standard-version": "9.5.0",
     "ts-node": "10",
-    "typescript": "4.9.5",
-    "yargs": "17.6.2"
+    "typescript": "5.0.3",
+    "yargs": "17.7.1"
   },
   "engines": {
     "node": ">=16.0.0"
@@ -104,7 +103,12 @@
       "@oclif/plugin-help",
       "@oclif/plugin-version",
       "@oclif/plugin-warn-if-update-available"
-    ]
+    ],
+    "warn-if-update-available": {
+      "timeoutInDays": 7,
+      "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>.",
+      "registry": "https://registry.npmjs.org"
+    }
   },
   "main": "lib/index.js",
   "repository": "terafina/tffa-sfdx-plugin",

package/lib/commands/tffa/apexdoc.d.ts

@@ -1,31 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { SfCommand } from '@salesforce/sf-plugins-core';
-export default class ApexDoc extends SfCommand<void> {
-    static description: string;
-    private logger;
-    static examples: string[];
-    private currentFile;
-    static readonly flags: {
-        sourcefolder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        destfolder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-    };
-    run(): Promise<void>;
-    /**
-     * Entry point for the program. Called by SFDX on extension activation.
-     *
-     * @param config The configuration collected from the users config,
-     * supplemented with any defaults if user did not include them.
-     */
-    private generateDocs;
-    private createClassGroupMap;
-    /**
-     * The main routine for parsing our Apex files. Here we collect ApexDox comments, and create
-     * models of our top-level types (Classes and Enums) and their members (Enum values, Methods,
-     * Properties, Inner Classes, etc.).
-     *
-     * @param filePath The path of the file being parsed
-     */
-    private parseFileContents;
-}

package/lib/commands/tffa/data/export.d.ts

@@ -1,71 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { FlagsConfig, SfdxCommand } from '@salesforce/command';
-export default class DataExport extends SfdxCommand {
-    static requiresUsername: boolean;
-    static description: string;
-    static examples: string[];
-    protected static flagsConfig: FlagsConfig;
-    /**
-     * Custom prefixes
-     */
-    private sObjectTypePrefixMap;
-    run(): Promise<any>;
-    private execute;
-    /**
-     * Gets fields to be included when exporting records.
-     */
-    private getFields;
-    /**
-     * Gets the field to be used for ordering when exporting the records.
-     */
-    private getOrderBy;
-    /**
-     * Transforms the exported records, making it ready for writing to config files
-     * @param records
-     */
-    private transform;
-    /**
-     * Gets the external id of the record
-     * @param record
-     * @returns
-     * @throws Error if external id or equivalent is not found
-     */
-    private getExternalId;
-    /**
-     * Gets the reference id for the record
-     * @param record
-     */
-    private getReferenceId;
-    /**
-     * Gets the object prefix to be used when building the reference id
-     * @param sObjectType
-     * @returns
-     */
-    private getPrefix;
-    /**
-     * Writes records to JSON files
-     * @param records
-     */
-    private writeRecords;
-    /**
-     * Counts the number of SObjects within the record. e.g. a record containing child relationships may contain more than one SObject.
-     * @param record
-     * @returns
-     */
-    private getSObjectCount;
-    /**
-     * Gets the export plan for the specified object type.
-     * @param sObjectType
-     * @returns
-     */
-    private getExportPlan;
-    private getChildExportPlan;
-    /**
-     * Returns a map of records where key is record.Id and value is record.
-     * @param records
-     * @returns
-     */
-    private toMap;
-}

package/lib/commands/tffa/data/import.d.ts

@@ -1,69 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { FlagsConfig, SfdxCommand } from '@salesforce/command';
-/**
- * Stores external id information of a record.
- * Stores both the external id field name and value.
- */
-declare type ExternalId = {
-    fieldName: string;
-    value: string;
-};
-export default class DataImport extends SfdxCommand {
-    static requiresUsername: boolean;
-    static requiresProject: boolean;
-    static description: string;
-    static examples: string[];
-    protected static flagsConfig: FlagsConfig;
-    protected referenceIdExternalIdMap: Map<string, ExternalId>;
-    private isScratch;
-    private namespacePrefix;
-    run(): Promise<any>;
-    /**
-     * Gathers external ids from the specified records. The external id of each record along with the external id field name
-     * is stored as a lookup reference mapped to the reference id of the record.
-     * @see referenceIdExternalIdMap
-     * @param records
-     */
-    private collectExternalIds;
-    /**
-     * Upserts the records using sfdx bulk2 API.
-     * @param records SObject records
-     */
-    private upsert;
-    /**
-     * Creates an upsert request for the records
-     * @param records
-     */
-    private createUpsertRequest;
-    /**
-     * Executes the upsert request. May include execution of child upsert requests if the records have child relationships.
-     * @param request
-     */
-    private execute;
-    /**
-     * Logs the success/error metrics
-     * @param result
-     * @param request
-     */
-    private logResult;
-    /**
-     * Checks if file has changed since the last time it was seen by comparing it's last modified date to last known one.
-     * @param sobjectfile
-     * @returns
-     */
-    private determineIfFileChanged;
-    /**
-     * Tracks the files for any changes in future. Uses last modified date to track changes.
-     * @param sobjectfiles
-     */
-    private trackFileChange;
-    /**
-     * Returns the external id field names to be used for:
-     * 1. resolving external ids of lookup references on records
-     * 2. resolving the external id of records for upsert
-     */
-    private getExternalIdFieldNames;
-}
-export {};

package/lib/commands/tffa/lint.d.ts

@@ -1,22 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { SfCommand } from '@salesforce/sf-plugins-core';
-export default class Lint extends SfCommand<void> {
-    static description: string;
-    static examples: string[];
-    private logger;
-    static readonly flags: {
-        sourcefolder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        minapi: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        rulesetpath: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        eject: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        level: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-    };
-    run(): Promise<any>;
-    /**
-     * print output
-     */
-    private printViolations;
-}

package/lib/commands/tffa/meta.d.ts

@@ -1,16 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { flags, SfdxCommand } from '@salesforce/command';
-export default class Meta extends SfdxCommand {
-    static description: string;
-    static examples: string[];
-    protected static flagsConfig: {
-        sourcefolder: flags.Discriminated<flags.String>;
-        destpath: flags.Discriminated<flags.String>;
-        clientname: flags.Discriminated<flags.String>;
-        output: flags.Discriminated<flags.Enum<string>>;
-        fields: flags.Discriminated<flags.Boolean<boolean>>;
-    };
-    run(): Promise<any>;
-}

package/lib/commands/tffa/ping.d.ts

@@ -1,14 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { SfdxCommand } from '@salesforce/command';
-import { AnyJson } from '@salesforce/ts-types';
-export default class Ping extends SfdxCommand {
-    static description: string;
-    static examples: string[];
-    static args: {
-        name: string;
-    }[];
-    protected static flagsConfig: {};
-    run(): Promise<AnyJson>;
-}

package/lib/commands/tffa/source/apiset.d.ts

@@ -1,11 +0,0 @@
-import { SfdxCommand, flags } from '@salesforce/command';
-export default class SourceApiSet extends SfdxCommand {
-    static description: string;
-    static examples: string[];
-    protected static flagsConfig: {
-        help: flags.Discriminated<flags.Boolean<void>>;
-        sourcefolder: flags.Discriminated<flags.String>;
-        api: flags.Discriminated<flags.Number>;
-    };
-    run(): Promise<any>;
-}

package/lib/commands/tffa/source/createfield.d.ts

@@ -1,41 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { SfdxCommand, FlagsConfig } from '@salesforce/command';
-/**
- * Copyright (c) NCR Terafina
- **/
-export default class CreateField extends SfdxCommand {
-    static requiresUsername: boolean;
-    static requiresProject: boolean;
-    static description: string;
-    static examples: string[];
-    protected static flagsConfig: FlagsConfig;
-    private projectdir;
-    run(): Promise<any>;
-    /**
-     * Creates a field definition for the field and writes it to the field-meta xml file.
-     * Additional attributes of the field definition are parsed from the flag parameters.
-     * @param sObjectType
-     * @param fieldName
-     */
-    private createField;
-    /**
-     * Adds a field permission entry for the field to the specified permission sets.
-     * @param permissionSets
-     * @param sObjectType
-     * @param fieldName
-     */
-    private addToPermissionSets;
-    /**
-     * Reads the xml file and returns an xml object
-     * @param filename
-     */
-    private readXml;
-    /**
-     * Writes the xml object into the specified file
-     * @param filename
-     * @param xmlObject
-     */
-    private writeXml;
-}

package/lib/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-declare const _default: {};
-export default _default;

package/lib/services/apexdoc/common/apex-docs-error.d.ts

@@ -1,23 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-declare class ApexDoxError extends Error {
-    static INVALID_SCOPE: string;
-    static SCOPE_ENTRIES_MAX: string;
-    static SCOPE_ENTRIES_MIN: string;
-    static INVALID_DIRECTORY: (arg: string, path: string) => string;
-    static INVALID_SORT_ORDER: (sortOrder: string) => string;
-    static INVALID_PORT: (port: number) => string;
-    static INVALID_SOURCE_URL: (url: string) => string;
-    static INVALID_TARGET_DIRECTORY: (path: string) => string;
-    static ONLY_STRINGS: (arg: string) => string;
-    static SCOPE_ENTRY_INVALID: (entry: string) => string;
-    static INVALID_TYPE: (arg: string, type: string) => string;
-    static NO_FILES_FOUND: (sourceDirs: string) => string;
-    static ASSET_NOT_FOUND: (asset: string) => string;
-    static INVALID_EXTENSION: (arg: string, path: string, extension: string) => string;
-    static INVALID_SEE_QUALIFIER: string;
-    static CONFIG_PARSE_ERROR: (fileName: string) => string;
-    static UNKNOWN_CONFIG_SETTING: (field: string) => string;
-}
-export default ApexDoxError;

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

@@ -1,9 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { IOnlyExcept } from '../index';
-export declare const last: <T>(arr: T[]) => T;
-export declare const head: <T>(arr: T[]) => T;
-export declare const tail: <T>(arr: T[]) => T[];
-export declare const except: IOnlyExcept;
-export declare const only: IOnlyExcept;

package/lib/services/apexdoc/common/line-reader.d.ts

@@ -1,40 +0,0 @@
-import { Option } from '../index';
-/**
- * A utility class similar to C#'s LineReader for synchronously reading a file line by line.
- * Uses Node's `readFileSync` to produce an array of lines and implements a simple iterator
- * to advance through them. This may be less space efficient than using Node's native line
- * reader, however, it keeps things synchronous, and avoids callbacks.
- */
-declare class LineReader {
-    private lines;
-    private nextIndex;
-    private end;
-    private content;
-    constructor(filePath: string);
-    /**
-     * Returns the next line and advances the reader a single step.
-     * @returns The next line, or null if there is no next line.
-     */
-    readLine(): Option<string, null>;
-    /**
-     * Returns the previous line without affecting the reader's position.
-     * @returns String, the previous line, or null if there is no previous line.
-     */
-    peekPrevLine(): Option<string, null>;
-    /**
-     * Returns the next line without advancing the reader.
-     * @returns String, the next line, or null if there is no next line.
-     */
-    peekNextLine(): Option<string, null>;
-    /**
-     * Convert the line reader's lines into a single string.
-     * @param trim A flag for determining whether or not white space
-     * between lines should be trimmed before concatenating into a
-     * single string.
-     * @param separator The character to join the lines by. Defaults to ''.
-     */
-    toString(trim?: boolean, separator?: string): string;
-    toContent(): string;
-    toArray(): string[];
-}
-export default LineReader;

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

@@ -1,51 +0,0 @@
-import { Option } from '../..';
-declare abstract class ApexModel {
-    protected _annotations: string[];
-    protected _author: string;
-    protected _deprecated: string;
-    protected _description: string;
-    protected _example: string;
-    protected _apipath: string;
-    protected _restUrl: string;
-    protected _apimethod: string;
-    protected _exception: string[];
-    protected _groupContentPath: string;
-    protected _groupName: string;
-    protected _tags: string;
-    protected _lineNum: number;
-    protected _nameLine: string;
-    protected _params: string[];
-    protected _queryparams: string[];
-    protected _requestheaders: string[];
-    protected _responseheaders: string[];
-    protected _returns: string;
-    protected _scope: string;
-    protected _see: string[];
-    protected _since: string;
-    protected _sourceUrl?: string;
-    protected _source: string;
-    protected constructor(comments: string[], sourceUrl: Option<string>);
-    abstract get name(): string;
-    get annotations(): string[];
-    get description(): string;
-    get lineNum(): number;
-    get nameLine(): string;
-    get scope(): string;
-    get sourceUrl(): Option<string>;
-    get source(): string;
-    setSource(source: string): void;
-    get example(): string;
-    get apipath(): string;
-    get restUrl(): string;
-    get apimethod(): string;
-    get deprecated(): string;
-    get see(): string[];
-    /**
-     * This method is based closely on: https://gitlab.com/StevenWCox/sfapexdoc/blob/master/src/apex/com/main/Model.java#L196
-     */
-    private parseComments;
-    parseAnnotations(line: string, previousLine: Option<string, null>): void;
-    protected parseScope(): void;
-    protected setNameLine(_nameLine: string, _lineNum: number): void;
-}
-export { ApexModel };

package/lib/services/apexdoc/common/models/class-group.d.ts

@@ -1,10 +0,0 @@
-declare class ClassGroup {
-    private _name;
-    private _contentSource;
-    constructor(name: string, contentSource: string);
-    get name(): string;
-    get contentSource(): string;
-    set contentSource(contentSource: string);
-    get contentFileName(): string;
-}
-export { ClassGroup };

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

@@ -1,41 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { EnumModel } from './enum-model';
-import { MethodModel } from './method-model';
-import { TopLevelModel } from './top-level-model';
-import { IDTODefinition, IRestPath, IRestTags, Option } from '../..';
-import { PropertyModel } from './property-model';
-declare class ClassModel extends TopLevelModel {
-    private _childClassMap;
-    private _cModelParent?;
-    private _enums;
-    private _isInterface;
-    private _methods;
-    private _properties;
-    private _hasGlobalMethods;
-    constructor(cModelParent: Option<ClassModel>, comments: string[], nameLine: string, lineNum: number, sourceUrl: Option<string>);
-    addChildClass(child: ClassModel): void;
-    get childClasses(): Array<ClassModel>;
-    get childClassesSorted(): Array<ClassModel>;
-    get childClassMap(): Map<string, ClassModel>;
-    get enums(): Array<EnumModel>;
-    get enumsSorted(): Array<EnumModel>;
-    get groupName(): string;
-    get tags(): IRestTags;
-    get isInterface(): boolean;
-    get isDTO(): boolean;
-    get methods(): Array<MethodModel>;
-    get restDefinition(): IRestPath[];
-    get dtoDefinition(): IDTODefinition;
-    get methodsSorted(): Array<MethodModel>;
-    get name(): string;
-    get properties(): Array<PropertyModel>;
-    get propertiesSorted(): Array<PropertyModel>;
-    get topMostClassName(): string;
-    private setIsInterface;
-    setHasGlobalMethods(_hasGlobalMethods: boolean): void;
-    get hasGlobalMethods(): boolean;
-    get isInnerClass(): boolean;
-}
-export { ClassModel };

package/lib/services/apexdoc/common/models/engine-config.d.ts

@@ -1,23 +0,0 @@
-import { IEngineConfig } from '../..';
-declare class EngineConfig implements IEngineConfig {
-    workspaceFolder: string;
-    port: number;
-    source: {
-        path: string;
-        sourceUrl: string;
-    }[];
-    targetDirectory: string;
-    includes: string[];
-    excludes: string[];
-    homePagePath: string;
-    scope: string[];
-    title: string;
-    subtitle: string;
-    showTOCSnippets: boolean;
-    sortOrder: string;
-    cleanDir: boolean;
-    assets: any[];
-    pages: any[];
-    constructor(workspaceFolder?: string, destfolder?: string);
-}
-export default EngineConfig;

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

@@ -1,15 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-import { TopLevelModel } from './top-level-model';
-import { Option } from '../..';
-declare class EnumModel extends TopLevelModel {
-    private _values;
-    constructor(comments: string[], nameLine: string, lineNum: number, sourceUrl: Option<string>);
-    get groupName(): string;
-    get name(): string;
-    get values(): string[];
-    protected setNameLine(nameLine: string, lineNum: number): void;
-    private setValues;
-}
-export { EnumModel };

package/lib/services/apexdoc/common/models/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * Copyright (c) NCR Terafina
- **/
-export * from './apex-model';
-export * from './class-group';
-export * from './class-model';
-export * from './enum-model';
-export * from './method-model';
-export * from './property-model';
-export * from './top-level-model';

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

@@ -1,26 +0,0 @@
-import { ApexModel } from './apex-model';
-import { IMethodException, IMethodParam, IMethodReturns, IQueryParam, IRequestHeader, IResponseHeader, Option } from '../..';
-declare class MethodModel extends ApexModel {
-    private _isConstructor;
-    constructor(comments: string[], nameLine: string, lineNum: number, className?: string, sourceUrl?: Option<string>);
-    get author(): string;
-    get exception(): Array<IMethodException>;
-    get isConstructor(): boolean;
-    get name(): string;
-    get params(): Array<IMethodParam>;
-    get queryparams(): Array<IQueryParam>;
-    get requestheaders(): Array<IRequestHeader>;
-    get responseheaders(): Array<IResponseHeader>;
-    get typesFromNameLine(): Map<string, string>;
-    get paramsFromNameLine(): string[];
-    get implicitReturnType(): string;
-    private isNumber;
-    get returns(): IMethodReturns;
-    parseAnnotations(line: string, previousLine: Option<string, null>): void;
-    protected parseScope(): void;
-    protected setNameLine(nameLine: string, lineNum: number): void;
-    get scope(): string;
-    set scope(scope: string);
-    get since(): string;
-}
-export { MethodModel };