npm - @terafina/tffa-sfdx-plugin - Versions diffs - 16.0.0-rc.1 → 16.0.0-rc.2 - Mend

@terafina/tffa-sfdx-plugin 16.0.0-rc.1 → 16.0.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/README.md +77 -6
package/lib/commands/tffa/data/export.d.ts +71 -0
package/lib/commands/tffa/data/export.js +382 -0
package/lib/commands/tffa/data/export.js.map +1 -0
package/messages/dataExport.js +32 -0
package/oclif.manifest.json +1 -1
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -41,7 +41,7 @@ $ npm install -g @terafina/tffa-sfdx-plugin
 $ sfdx COMMAND
 running command...
 $ sfdx (--version|-v)
-@terafina/tffa-sfdx-plugin/16.0.0-rc.1 linux-x64 node-v16.13.1
+@terafina/tffa-sfdx-plugin/16.0.0-rc.2 linux-x64 node-v16.13.1
 $ sfdx --help [COMMAND]
 USAGE
   $ sfdx COMMAND
@@ -54,6 +54,7 @@ USAGE
   <!-- commands -->
 * [`sfdx help [COMMAND]`](#sfdx-help-command)
 * [`sfdx tffa:apexdoc [-s <directory>] [-d <directory>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-tffaapexdoc--s-directory--d-directory---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
+* [`sfdx tffa:data:export -s <array> [-d <string>] [-g <string>] [-o <array>] [-c <array>] [-s] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-tffadataexport--s-array--d-string--g-string--o-array--c-array--s--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
 * [`sfdx tffa:lint [-s <directory>] [-m <integer>] [-r <filepath>] [-e] [-f] [-j] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-tffalint--s-directory--m-integer--r-filepath--e--f--j---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
 * [`sfdx tffa:meta [-s <directory>] [-d <directory>] [-c <directory>] [-o json|csv|human] [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-tffameta--s-directory--d-directory--c-directory--o-jsoncsvhuman--f---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
 * [`sfdx tffa:ping [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-tffaping---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
@@ -104,7 +105,77 @@ EXAMPLES
   Generate Apex API Documentation :	$sfdx tffa:apexdoc
 ```
-_See code: [src/commands/tffa/apexdoc.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.1/src/commands/tffa/apexdoc.ts)_
+_See code: [src/commands/tffa/apexdoc.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.2/src/commands/tffa/apexdoc.ts)_
+## `sfdx tffa:data:export -s <array> [-d <string>] [-g <string>] [-o <array>] [-c <array>] [-s] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
+Exports records of specified sobject types from target org into JSON file(s). Primarily used for exporting business configurations.
+```
+USAGE
+  $ sfdx tffa:data:export -s <array> [-d <string>] [-g <string>] [-o <array>] [-c <array>] [-s] [-u <string>]
+    [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
+FLAGS
+  -c, --children=<value>
+      the child relationships to be included in the exported records; this is not required for tffa package objects. e.g.
+      tffa__Features__r,tffa__Terms__r child relationships are auto included when running export command for
+      tffa__Product__c
+  -d, --outputdir=<value>
+      [default: ./data/configuration] output directory where the JSON files of exported records will be placed
+  -g, --groupby=<value>
+      the field to be used for grouping the exported records; records belonging to each group are placed in separate JSON
+      files (filename suffixed by group name)
+  -o, --orderby=<value>
+      the fields to be used for sorting the exported records
+  -s, --skipconfigplan
+      skip import of exported record JSON files into configuration plan
+  -s, --sobjecttype=<value>
+      (required) sobject types of records to be exported
+  -u, --targetusername=<value>
+      username or alias for the target org; overrides default target org
+  --apiversion=<value>
+      override the api version used for api requests made by this command
+  --json
+      format output as json
+  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
+      [default: warn] logging level for this command invocation
+DESCRIPTION
+  Exports records of specified sobject types from target org into JSON file(s). Primarily used for exporting business
+  configurations.
+  The export command requires a target org for exporting records. Run this command from within a sfdx project containing
+  a default username or specify targetusername explicitly.
+EXAMPLES
+  $ sfdx tffa:data:export --sobjecttype tffa__Product__c
+      Fetched 101 records of tffa__Product__c
+      Writing 24 records to ./data/configuration/Product__c.json
+      Writing 30 records to ./data/configuration/Product__c1.json
+      Writing 20 records to ./data/configuration/Product__c2.json
+      Writing 27 records to ./data/configuration/Product__c3.json
+  $ sfdx tffa:data:export --sobjecttype tffa__DisclosureTemplate__c,tffa__DisclosureChecklist__c,tffa__DisclosureMatrix__c
+      Fetched 81 records of tffa__DisclosureTemplate__c
+      Writing 81 records to ./data/configuration/DisclosureTemplate__c.json
+      Fetched 57 records of tffa__DisclosureChecklist__c
+      Writing 57 records to ./data/configuration/DisclosureChecklist__c.json
+      Fetched 144 records of tffa__DisclosureMatrix__c
+      Writing 144 records to ./data/configuration/DisclosureMatrix__c.json
+```
+_See code: [src/commands/tffa/data/export.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.2/src/commands/tffa/data/export.ts)_
 ## `sfdx tffa:lint [-s <directory>] [-m <integer>] [-r <filepath>] [-e] [-f] [-j] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
@@ -134,7 +205,7 @@ EXAMPLES
   $sfdx tffa:lint
 ```
-_See code: [src/commands/tffa/lint.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.1/src/commands/tffa/lint.ts)_
+_See code: [src/commands/tffa/lint.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.2/src/commands/tffa/lint.ts)_
 ## `sfdx tffa:meta [-s <directory>] [-d <directory>] [-c <directory>] [-o json|csv|human] [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
@@ -163,7 +234,7 @@ EXAMPLES
   scan a sfdx project for metadata :	$sfdx tffa:meta
 ```
-_See code: [src/commands/tffa/meta.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.1/src/commands/tffa/meta.ts)_
+_See code: [src/commands/tffa/meta.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.2/src/commands/tffa/meta.ts)_
 ## `sfdx tffa:ping [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
@@ -185,7 +256,7 @@ EXAMPLES
   $ sfdx tffa:ping
 ```
-_See code: [src/commands/tffa/ping.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.1/src/commands/tffa/ping.ts)_
+_See code: [src/commands/tffa/ping.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.2/src/commands/tffa/ping.ts)_
 ## `sfdx tffa:source:apiset [-h <help>] [-s <directory>] [-a <integer>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
@@ -213,7 +284,7 @@ EXAMPLES
   $ sfdx tffa:source:apiset
 ```
-_See code: [src/commands/tffa/source/apiset.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.1/src/commands/tffa/source/apiset.ts)_
+_See code: [src/commands/tffa/source/apiset.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v16.0.0-rc.2/src/commands/tffa/source/apiset.ts)_
 ## `sfdx version`

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

@@ -0,0 +1,71 @@
+/**
+ * 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/export.js ADDED Viewed

@@ -0,0 +1,382 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const command_1 = require("@salesforce/command");
+const core_1 = require("@salesforce/core");
+const fs_extra_1 = require("fs-extra");
+// Initialize Messages with the current plugin directory
+core_1.Messages.importMessagesDirectory(__dirname);
+// Load the specific messages for this file. Messages from @salesforce/command, @salesforce/core,
+// or any library that is using the messages framework can also be loaded this way.
+const messages = core_1.Messages.loadMessages('@terafina/tffa-sfdx-plugin', 'dataExport');
+/**
+ * Represents a plan to export records of a specific SObject type.
+ */
+class ExportPlan {
+    constructor(plan) {
+        Object.assign(this, plan);
+        if (!this.name) {
+            this.name = this.sObjectType;
+        }
+    }
+}
+/**
+ * Common regex used
+ */
+const NON_ALPHANUM_RE = /[^a-zA-Z0-9]+/g;
+const UPPER_LOWER_RE = /[A-Z][a-z]+/g;
+const REFERENCE_ID_RE = /referenceId/g;
+const MAX_OBJECTS_IN_FILE = 200;
+/**
+ * Some internal configurations
+ */
+const EXCLUDED_FIELDS = new Set(['OwnerId', 'RecordTypeId', 'tffa__IsDeleted__c']);
+const EXTERNAL_ID_FIELDS = new Set(['ExternalId__c', 'tffa__ExternalId__c']);
+const SORT_ORDER_FIELDS = new Set(['SortOrder__c', 'tffa__SortOrder__c']);
+const CONTENT_URL_FIELDS = new Set(['ImageUrl__c', 'tffa__ImageUrl__c', 'tffa__Url__c']);
+/**
+ * Export plans of SObject types that require fetching of child relationships, custom grouping, sorting  etc.
+ * Export plans of SObject types that are simple and limited to itself need not be included here.
+ */
+const EXPORT_PLANS = Object.fromEntries([
+    new ExportPlan({
+        sObjectType: 'tffa__Product__c',
+        children: ['tffa__Features__r', 'tffa__Terms__r'],
+        where: "tffa__Type__c='PRODUCT'"
+    }),
+    new ExportPlan({
+        sObjectType: 'tffa__Questionnaire__c',
+        groupBy: 'tffa__Type__c',
+        children: ['tffa__Outcomes__r', 'tffa__QuestionGroups__r'],
+        prefix: 'qn'
+    }),
+    new ExportPlan({ sObjectType: 'tffa__QuestionGroupTemplate__c', children: ['tffa__Questions__r'] }),
+    new ExportPlan({ sObjectType: 'tffa__AddOnService__c', orderBy: ['tffa__Type__c', 'Name'] }),
+    new ExportPlan({
+        sObjectType: 'tffa__ApplicationDecisionMatrix__c',
+        children: ['tffa__CounterOffers__r'],
+        orderBy: ['tffa__Type__c', 'tffa__SortOrder__c']
+    }),
+    new ExportPlan({ sObjectType: 'tffa__Brand__c', children: ['tffa__Locations__r'], prefix: 'brand', orderBy: ['tffa__SortOrder__c'] }),
+    new ExportPlan({ sObjectType: 'tffa__DecisionStrategyConfiguration__c', children: ['tffa__Strategies__r'] }),
+    new ExportPlan({ sObjectType: 'tffa__Offer__c', children: ['tffa__Terms__r'], orderBy: ['tffa__ProductCategory__c', 'Name'] }),
+    new ExportPlan({ sObjectType: 'tffa__Promotion__c', children: ['tffa__Plans__r'], prefix: 'pr' }),
+    new ExportPlan({ sObjectType: 'tffa__ListOfValues__c', groupBy: 'tffa__Locale__c' }),
+    new ExportPlan({
+        name: 'tffa__ProductBundle__c',
+        sObjectType: 'tffa__Product__c',
+        children: ['tffa__Features__r', 'tffa__Terms__r', 'tffa__ProductXrefs__r'],
+        where: "tffa__Type__c='BUNDLE'"
+    }),
+    new ExportPlan({ name: 'tffa__Address__c', sObjectType: 'tffa__Location__c', map: l => l.tffa__Address__r, prefix: 'addr' }),
+    new ExportPlan({ sObjectType: 'tffa__AddOnServiceChecklist__c', children: ['tffa__Items__r'], prefix: 'aoscl' }),
+    new ExportPlan({ sObjectType: 'tffa__DisclosureChecklist__c', children: ['tffa__Items__r'], prefix: 'dcl' }),
+    new ExportPlan({ sObjectType: 'tffa__StipulationChecklist__c', children: ['tffa__Items__r'], prefix: 'scl' }),
+    new ExportPlan({ sObjectType: 'tffa__DepositBoxConfiguration__c', children: ['tffa__Items__r'] }),
+    new ExportPlan({ sObjectType: 'tffa__RecommendationConfiguration__c', children: ['tffa__Items__r'] }),
+    new ExportPlan({ sObjectType: 'tffa__UXStrategy__c', prefix: 'uxs', orderBy: ['tffa__AppPage__c', 'tffa__SortOrder__c'] }),
+    new ExportPlan({ sObjectType: 'tffa__AllowedAddress__c', orderBy: ['tffa__SortOrder__c'] }),
+    new ExportPlan({ sObjectType: 'tffa__QuestionnaireMatrix__c', orderBy: ['tffa__Type__c', 'tffa__SortOrder__c'] })
+].map(p => [p.name, p]));
+class DataExport extends command_1.SfdxCommand {
+    constructor() {
+        super(...arguments);
+        /**
+         * Custom prefixes
+         */
+        this.sObjectTypePrefixMap = new Map();
+    }
+    async run() {
+        for (const sObjectType of this.flags.sobjecttype) {
+            const plan = this.getExportPlan(sObjectType);
+            this.ux.startSpinner(`Fetching record(s) of ${sObjectType}`);
+            const records = await this.execute(plan);
+            this.ux.stopSpinner(`completed`);
+            this.log(`Fetched ${records.length} records of ${sObjectType}`);
+            this.transform(records);
+            if (records.length) {
+                this.writeRecords(records, plan);
+            }
+        }
+    }
+    async execute(plan, parent) {
+        let qb = this.org
+            .getConnection()
+            .sobject(plan.sObjectType)
+            .select(await this.getFields(plan, !!parent))
+            .orderby((await this.getOrderBy(plan, !parent && !plan.sObjectType.endsWith('Matrix__c'))).map(e => [e, 'asc']))
+            .where(plan.where);
+        for (const child of plan.children || []) {
+            const childPlan = await this.getChildExportPlan(plan.sObjectType, child);
+            qb = qb
+                .include(child)
+                .select(await this.getFields(childPlan, true))
+                .orderby((await this.getOrderBy(childPlan)).map(e => [e, 'asc']))
+                .end();
+        }
+        let records = await qb.execute();
+        if (plan.map) {
+            records = records.map(plan.map);
+        }
+        for (const child of plan.children || []) {
+            const childPlan = await this.getChildExportPlan(plan.sObjectType, child);
+            if (childPlan.children?.length) {
+                const childRecordMap = this.toMap(await this.execute(childPlan, plan));
+                for (const record of records) {
+                    const relationshipNode = record[child];
+                    if (relationshipNode) {
+                        for (const [i, childRecord] of relationshipNode.records.entries()) {
+                            relationshipNode.records[i] = childRecordMap.get(childRecord.Id) || childRecord;
+                        }
+                    }
+                }
+            }
+        }
+        return records;
+    }
+    /**
+     * Gets fields to be included when exporting records.
+     */
+    async getFields(plan, skipMasterDetail = false, skipLookup = false) {
+        const sObjectType = plan.sObjectType;
+        const fields = ['Id'];
+        const conn = this.org.getConnection();
+        const describeResult = await conn.describe$(sObjectType);
+        for (const f of describeResult.fields) {
+            if (EXCLUDED_FIELDS.has(f.name) || !f.createable) {
+                continue;
+            }
+            if (f.referenceTo?.length) {
+                if (!skipLookup && (f.relationshipOrder !== 0 || !skipMasterDetail)) {
+                    fields.push(f.name);
+                    const refFields = await this.getFields(new ExportPlan({ sObjectType: f.referenceTo[0] }), true, true);
+                    refFields.forEach(lf => fields.push(`${f.relationshipName}.${lf}`));
+                }
+            }
+            else {
+                fields.push(f.name);
+            }
+        }
+        return fields;
+    }
+    /**
+     * Gets the field to be used for ordering when exporting the records.
+     */
+    async getOrderBy(plan, skipSortOrder = false) {
+        const sObjectType = plan.sObjectType;
+        if (plan.orderBy) {
+            return plan.orderBy;
+        }
+        let sortOrderField = ['Name'];
+        if (!skipSortOrder) {
+            const describeResult = await this.org.getConnection().describe$(sObjectType);
+            for (const f of describeResult.fields) {
+                if (SORT_ORDER_FIELDS.has(f.name)) {
+                    sortOrderField = [f.name];
+                    break;
+                }
+            }
+        }
+        return sortOrderField;
+    }
+    /**
+     * Transforms the exported records, making it ready for writing to config files
+     * @param records
+     */
+    transform(records) {
+        for (const record of records) {
+            record.attributes.referenceId = this.getReferenceId(record);
+            record.attributes.url = undefined;
+            record.Id = undefined;
+            for (const [k, v] of Object.entries(record)) {
+                if (v === null || v === undefined) {
+                    record[k] = undefined;
+                }
+                else if (typeof v === 'object' && k.endsWith('__r')) {
+                    if (v.records) {
+                        this.transform(v.records);
+                    }
+                    else {
+                        record[k.replace('__r', '__c')] = `@${this.getReferenceId(v)}`;
+                        record[k] = undefined;
+                    }
+                }
+                else {
+                    if (CONTENT_URL_FIELDS.has(k) && v.startsWith('/file-asset')) {
+                        const url = new URL(v, 'http://localhost');
+                        url.searchParams.delete('oid');
+                        record[k] = url.pathname + url.search;
+                    }
+                }
+            }
+        }
+    }
+    /**
+     * Gets the external id of the record
+     * @param record
+     * @returns
+     * @throws Error if external id or equivalent is not found
+     */
+    getExternalId(record) {
+        let externalId;
+        for (const externalIdField of EXTERNAL_ID_FIELDS) {
+            externalId = record[externalIdField];
+            if (externalId) {
+                break;
+            }
+        }
+        if (!externalId) {
+            throw new Error(`No external id found for sobject ${record.attributes.type} id=${record.Id}`);
+        }
+        return externalId;
+    }
+    /**
+     * Gets the reference id for the record
+     * @param record
+     */
+    getReferenceId(record) {
+        const sObjectType = record.attributes.type;
+        return `${this.getPrefix(sObjectType)}_${this.getExternalId(record)}`.replace(NON_ALPHANUM_RE, '_');
+    }
+    /**
+     * Gets the object prefix to be used when building the reference id
+     * @param sObjectType
+     * @returns
+     */
+    getPrefix(sObjectType) {
+        let prefix = this.sObjectTypePrefixMap.get(sObjectType) || this.getExportPlan(sObjectType).prefix;
+        if (!prefix) {
+            prefix = sObjectType
+                .match(UPPER_LOWER_RE)
+                .map(e => e[0])
+                .join('')
+                .toLowerCase();
+            this.sObjectTypePrefixMap.set(sObjectType, prefix);
+        }
+        return prefix;
+    }
+    /**
+     * Writes records to JSON files
+     * @param records
+     */
+    writeRecords(records, plan) {
+        const objectName = plan.name.replace('tffa__', '');
+        const outputDir = this.flags.outputdir;
+        const groupBy = plan.groupBy || '_';
+        (0, fs_extra_1.mkdirpSync)(outputDir);
+        const groupMap = new Map();
+        if (groupBy === '_') {
+            groupMap.set(groupBy, records);
+        }
+        else {
+            for (const record of records) {
+                const k = record[groupBy] || '_';
+                const group = groupMap.get(k) || groupMap.set(k, []).get(k);
+                group.push(record);
+            }
+        }
+        const filenames = [];
+        for (const [k, group] of groupMap.entries()) {
+            let batch = [];
+            let batchObjectCount = 0;
+            const batches = [batch];
+            for (const record of group) {
+                const count = this.getSObjectCount(record);
+                if (count + batchObjectCount > MAX_OBJECTS_IN_FILE) {
+                    batch = [];
+                    batches.push(batch);
+                    batchObjectCount = 0;
+                }
+                batch.push(record);
+                batchObjectCount += count;
+            }
+            for (const [i, batch] of batches.entries()) {
+                const filename = `${objectName}${k === '_' ? '' : '-' + k}${i || ''}.json`;
+                const filepath = `${outputDir}/${filename}`;
+                this.log(`Writing ${batch.length} records to ${filepath}`);
+                (0, fs_extra_1.writeFileSync)(filepath, JSON.stringify({ records: batch }, null, 2));
+                filenames.push(filename);
+            }
+        }
+        if (!this.flags.skipconfigplan && plan.name === plan.sObjectType) {
+            const configPlanFilepath = `${outputDir}/config-data-plan.json`;
+            if ((0, fs_extra_1.existsSync)(configPlanFilepath)) {
+                const configPlans = JSON.parse((0, fs_extra_1.readFileSync)(configPlanFilepath, 'utf-8'));
+                let configPlan = configPlans.find(cp => cp.sobject === plan.sObjectType);
+                if (!configPlan) {
+                    configPlan = { sobject: plan.sObjectType, files: [] };
+                    configPlans.push(configPlan);
+                }
+                // update only if something changed
+                if (configPlan.files?.toString() !== filenames.toString()) {
+                    configPlan.files = filenames;
+                    (0, fs_extra_1.writeFileSync)(configPlanFilepath, JSON.stringify(configPlans, null, 2));
+                }
+            }
+        }
+    }
+    /**
+     * Counts the number of SObjects within the record. e.g. a record containing child relationships may contain more than one SObject.
+     * @param record
+     * @returns
+     */
+    getSObjectCount(record) {
+        return (JSON.stringify(record).match(REFERENCE_ID_RE) || []).length;
+    }
+    /**
+     * Gets the export plan for the specified object type.
+     * @param sObjectType
+     * @returns
+     */
+    getExportPlan(sObjectType) {
+        const plan = new ExportPlan({ sObjectType, ...(EXPORT_PLANS[sObjectType] || {}) });
+        const { sobjecttype: sobjecttypes, children, groupby, orderby } = this.flags;
+        if (sobjecttypes.length === 1 && sobjecttypes[0] === sObjectType) {
+            if (children) {
+                plan.children = children;
+            }
+            if (groupby) {
+                plan.groupBy = groupby;
+            }
+            if (orderby) {
+                plan.orderBy = orderby;
+            }
+        }
+        return plan;
+    }
+    async getChildExportPlan(sObjectType, relationshipName) {
+        const describeResult = await this.org.getConnection().describe$(sObjectType);
+        const relationship = describeResult.childRelationships.find(f => f.relationshipName === relationshipName);
+        if (!relationship) {
+            throw new Error(`Relationship ${relationshipName} not found on SObjectType ${sObjectType}`);
+        }
+        return this.getExportPlan(relationship.childSObject);
+    }
+    /**
+     * Returns a map of records where key is record.Id and value is record.
+     * @param records
+     * @returns
+     */
+    toMap(records) {
+        const recordMap = new Map();
+        for (const record of records) {
+            recordMap.set(record.Id, record);
+        }
+        return recordMap;
+    }
+}
+exports.default = DataExport;
+DataExport.requiresUsername = true;
+DataExport.description = messages.getMessage('commandDescription');
+DataExport.examples = messages.getMessages('commandExamples');
+DataExport.flagsConfig = {
+    sobjecttype: command_1.flags.array({ char: 's', required: true, description: messages.getMessage('sobjecttypeFlagDescription') }),
+    outputdir: command_1.flags.string({ char: 'd', description: messages.getMessage('outputdirFlagDescription'), default: './data/configuration' }),
+    groupby: command_1.flags.string({ char: 'g', required: false, description: messages.getMessage('groupbyFlagDescription') }),
+    orderby: command_1.flags.array({ char: 'o', required: false, description: messages.getMessage('orderbyFlagDescription') }),
+    children: command_1.flags.array({ char: 'c', required: false, description: messages.getMessage('childrenFlagDescription') }),
+    skipconfigplan: command_1.flags.boolean({ char: 's', required: false, description: messages.getMessage('skipconfigplanFlagDescription') })
+};
+//# sourceMappingURL=export.js.map

package/lib/commands/tffa/data/export.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"export.js","sourceRoot":"","sources":["../../../../src/commands/tffa/data/export.ts"],"names":[],"mappings":";;AAAA;;IAEI;AACJ,iDAAsE;AACtE,2CAA4C;AAC5C,uCAA+E;AAE/E,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAE5C,iGAAiG;AACjG,mFAAmF;AACnF,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,4BAA4B,EAAE,YAAY,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,UAAU;IAmCd,YAAY,IAAyB;QACnC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;SAC9B;IACH,CAAC;CACF;AAgBD;;GAEG;AACH,MAAM,eAAe,GAAG,gBAAgB,CAAC;AACzC,MAAM,cAAc,GAAG,cAAc,CAAC;AACtC,MAAM,eAAe,GAAG,cAAc,CAAC;AACvC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEhC;;GAEG;AACH,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,cAAc,EAAE,oBAAoB,CAAC,CAAC,CAAC;AACnF,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,eAAe,EAAE,qBAAqB,CAAC,CAAC,CAAC;AAC7E,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC,CAAC;AAC1E,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC;AAEzF;;;GAGG;AACH,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CACrC;IACE,IAAI,UAAU,CAAC;QACb,WAAW,EAAE,kBAAkB;QAC/B,QAAQ,EAAE,CAAC,mBAAmB,EAAE,gBAAgB,CAAC;QACjD,KAAK,EAAE,yBAAyB;KACjC,CAAC;IACF,IAAI,UAAU,CAAC;QACb,WAAW,EAAE,wBAAwB;QACrC,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,CAAC,mBAAmB,EAAE,yBAAyB,CAAC;QAC1D,MAAM,EAAE,IAAI;KACb,CAAC;IACF,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,gCAAgC,EAAE,QAAQ,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC;IACnG,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,uBAAuB,EAAE,OAAO,EAAE,CAAC,eAAe,EAAE,MAAM,CAAC,EAAE,CAAC;IAC5F,IAAI,UAAU,CAAC;QACb,WAAW,EAAE,oCAAoC;QACjD,QAAQ,EAAE,CAAC,wBAAwB,CAAC;QACpC,OAAO,EAAE,CAAC,eAAe,EAAE,oBAAoB,CAAC;KACjD,CAAC;IACF,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC;IACrI,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,wCAAwC,EAAE,QAAQ,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC;IAC5G,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC,EAAE,OAAO,EAAE,CAAC,0BAA0B,EAAE,MAAM,CAAC,EAAE,CAAC;IAC9H,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACjG,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,uBAAuB,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;IACpF,IAAI,UAAU,CAAC;QACb,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,kBAAkB;QAC/B,QAAQ,EAAE,CAAC,mBAAmB,EAAE,gBAAgB,EAAE,uBAAuB,CAAC;QAC1E,KAAK,EAAE,wBAAwB;KAChC,CAAC;IACF,IAAI,UAAU,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,WAAW,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAC5H,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,gCAAgC,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAChH,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,8BAA8B,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC5G,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,+BAA+B,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC7G,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,kCAAkC,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC;IACjG,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,sCAAsC,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC;IACrG,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,EAAE,CAAC;IAC1H,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,OAAO,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC;IAC3F,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,8BAA8B,EAAE,OAAO,EAAE,CAAC,eAAe,EAAE,oBAAoB,CAAC,EAAE,CAAC;CAClH,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CACxB,CAAC;AAEF,MAAqB,UAAW,SAAQ,qBAAW;IAAnD;;QAaE;;WAEG;QACK,yBAAoB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAkS3D,CAAC;IAhSC,KAAK,CAAC,GAAG;QACP,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;YAChD,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAC7C,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;YAC7D,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,WAAW,OAAO,CAAC,MAAM,eAAe,WAAW,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACxB,IAAI,OAAO,CAAC,MAAM,EAAE;gBAClB,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;aAClC;SACF;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,IAAgB,EAAE,MAAmB;QACzD,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG;aACd,aAAa,EAAE;aACf,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;aACzB,MAAM,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;aAC5C,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;aAChI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE;YACvC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YACzE,EAAE,GAAG,EAAE;iBACJ,OAAO,CAAC,KAAK,CAAC;iBACd,MAAM,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;iBAC7C,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;iBACjF,GAAG,EAAE,CAAC;SACV;QACD,IAAI,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,GAAG,EAAE;YACZ,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACjC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE;YACvC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YACzE,IAAI,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE;gBAC9B,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;gBACvE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;oBAC5B,MAAM,gBAAgB,GAAG,MAAM,CAAC,KAAK,CAAiC,CAAC;oBACvE,IAAI,gBAAgB,EAAE;wBACpB,KAAK,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE;4BACjE,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC;yBACjF;qBACF;iBACF;aACF;SACF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,SAAS,CAAC,IAAgB,EAAE,gBAAgB,GAAG,KAAK,EAAE,UAAU,GAAG,KAAK;QACpF,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;QACtB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QACtC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACzD,KAAK,MAAM,CAAC,IAAI,cAAc,CAAC,MAAM,EAAE;YACrC,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE;gBAChD,SAAS;aACV;YACD,IAAI,CAAC,CAAC,WAAW,EAAE,MAAM,EAAE;gBACzB,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,iBAAiB,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE;oBACnE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;oBACpB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;oBACtG,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,gBAAgB,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;iBACrE;aACF;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;aACrB;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,UAAU,CAAC,IAAgB,EAAE,aAAa,GAAG,KAAK;QAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,IAAI,CAAC,OAAO,CAAC;SACrB;QACD,IAAI,cAAc,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAC7E,KAAK,MAAM,CAAC,IAAI,cAAc,CAAC,MAAM,EAAE;gBACrC,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;oBACjC,cAAc,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;oBAC1B,MAAM;iBACP;aACF;SACF;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACK,SAAS,CAAC,OAAwB;QACxC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,MAAM,CAAC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAC5D,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,SAAS,CAAC;YAClC,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;YACtB,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC3C,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,EAAE;oBACjC,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;iBACvB;qBAAM,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBACrD,IAAI,CAAC,CAAC,OAAO,EAAE;wBACb,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;qBAC3B;yBAAM;wBACL,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC/D,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;qBACvB;iBACF;qBAAM;oBACL,IAAI,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;wBAC5D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC;wBAC3C,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;wBAC/B,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC;qBACvC;iBACF;aACF;SACF;IACH,CAAC;IAED;;;;;OAKG;IACK,aAAa,CAAC,MAAqB;QACzC,IAAI,UAAkB,CAAC;QACvB,KAAK,MAAM,eAAe,IAAI,kBAAkB,EAAE;YAChD,UAAU,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;YACrC,IAAI,UAAU,EAAE;gBACd,MAAM;aACP;SACF;QACD,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,oCAAoC,MAAM,CAAC,UAAU,CAAC,IAAI,OAAO,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;SAC/F;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;OAGG;IACK,cAAc,CAAC,MAAqB;QAC1C,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC;QAC3C,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;IACtG,CAAC;IAED;;;;OAIG;IACK,SAAS,CAAC,WAAmB;QACnC,IAAI,MAAM,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC;QAClG,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,WAAW;iBACjB,KAAK,CAAC,cAAc,CAAC;iBACrB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;iBACd,IAAI,CAAC,EAAE,CAAC;iBACR,WAAW,EAAE,CAAC;YACjB,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;SACpD;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACK,YAAY,CAAC,OAAwB,EAAE,IAAgB;QAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACnD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC;QAEpC,IAAA,qBAAU,EAAC,SAAS,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAiB,CAAC;QAC1C,IAAI,OAAO,KAAK,GAAG,EAAE;YACnB,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SAChC;aAAM;YACL,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;gBACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC5D,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACpB;SACF;QACD,MAAM,SAAS,GAAa,EAAE,CAAC;QAC/B,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE;YAC3C,IAAI,KAAK,GAAG,EAAE,CAAC;YACf,IAAI,gBAAgB,GAAG,CAAC,CAAC;YACzB,MAAM,OAAO,GAAY,CAAC,KAAK,CAAC,CAAC;YAEjC,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE;gBAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;gBAC3C,IAAI,KAAK,GAAG,gBAAgB,GAAG,mBAAmB,EAAE;oBAClD,KAAK,GAAG,EAAE,CAAC;oBACX,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACpB,gBAAgB,GAAG,CAAC,CAAC;iBACtB;gBACD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACnB,gBAAgB,IAAI,KAAK,CAAC;aAC3B;YACD,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE;gBAC1C,MAAM,QAAQ,GAAG,GAAG,UAAU,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC;gBAC3E,MAAM,QAAQ,GAAG,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC;gBAC5C,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,CAAC,MAAM,eAAe,QAAQ,EAAE,CAAC,CAAC;gBAC3D,IAAA,wBAAa,EAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC1B;SACF;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,EAAE;YAChE,MAAM,kBAAkB,GAAG,GAAG,SAAS,wBAAwB,CAAC;YAChE,IAAI,IAAA,qBAAU,EAAC,kBAAkB,CAAC,EAAE;gBAClC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,uBAAY,EAAC,kBAAkB,EAAE,OAAO,CAAC,CAA2C,CAAC;gBACpH,IAAI,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC;gBACzE,IAAI,CAAC,UAAU,EAAE;oBACf,UAAU,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;oBACtD,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;iBAC9B;gBACD,mCAAmC;gBACnC,IAAI,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,SAAS,CAAC,QAAQ,EAAE,EAAE;oBACzD,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC;oBAC7B,IAAA,wBAAa,EAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;iBACzE;aACF;SACF;IACH,CAAC;IAED;;;;OAIG;IACK,eAAe,CAAC,MAAqB;QAC3C,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACK,aAAa,CAAC,WAAmB;QACvC,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACnF,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC7E,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,KAAK,WAAW,EAAE;YAChE,IAAI,QAAQ,EAAE;gBACZ,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;aAC1B;YACD,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;aACxB;YACD,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;aACxB;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,WAAmB,EAAE,gBAAwB;QAC5E,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC7E,MAAM,YAAY,GAAG,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,gBAAgB,CAAC,CAAC;QAC1G,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,gBAAgB,gBAAgB,6BAA6B,WAAW,EAAE,CAAC,CAAC;SAC7F;QACD,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,OAAwB;QACpC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;QACnD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAClC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;;AAjTH,6BAkTC;AAjTe,2BAAgB,GAAG,IAAI,CAAC;AACxB,sBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AACxD,mBAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;AAChD,sBAAW,GAAgB;IAC1C,WAAW,EAAE,eAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC,EAAE,CAAC;IACvH,SAAS,EAAE,eAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC;IACrI,OAAO,EAAE,eAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC,EAAE,CAAC;IACjH,OAAO,EAAE,eAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC,EAAE,CAAC;IAChH,QAAQ,EAAE,eAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC,EAAE,CAAC;IAClH,cAAc,EAAE,eAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC,EAAE,CAAC;CACjI,CAAC"}

package/messages/dataExport.js ADDED Viewed

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+module.exports = {
+  commandDescription: `Exports records of specified sobject types from target org into JSON file(s). Primarily used for exporting business configurations.
+The export command requires a target org for exporting records. Run this command from within a sfdx project containing a default username or specify targetusername explicitly.`,
+  sobjecttypeFlagDescription: 'sobject types of records to be exported',
+  outputdirFlagDescription: 'output directory where the JSON files of exported records will be placed',
+  groupbyFlagDescription:
+    'the field to be used for grouping the exported records; records belonging to each group are placed in separate JSON files (filename suffixed by group name)',
+  orderbyFlagDescription: 'the fields to be used for sorting the exported records',
+  childrenFlagDescription:
+    'the child relationships to be included in the exported records; this is not required for tffa package objects. e.g. tffa__Features__r,tffa__Terms__r child relationships are auto included when running export command for tffa__Product__c',
+  skipconfigplanFlagDescription: 'skip import of exported record JSON files into configuration plan',
+  commandExamples: [
+    `$ sfdx tffa:data:export --sobjecttype tffa__Product__c
+    Fetched 101 records of tffa__Product__c
+    Writing 24 records to ./data/configuration/Product__c.json
+    Writing 30 records to ./data/configuration/Product__c1.json
+    Writing 20 records to ./data/configuration/Product__c2.json
+    Writing 27 records to ./data/configuration/Product__c3.json
+    `,
+    `$ sfdx tffa:data:export --sobjecttype tffa__DisclosureTemplate__c,tffa__DisclosureChecklist__c,tffa__DisclosureMatrix__c
+    Fetched 81 records of tffa__DisclosureTemplate__c
+    Writing 81 records to ./data/configuration/DisclosureTemplate__c.json
+    Fetched 57 records of tffa__DisclosureChecklist__c
+    Writing 57 records to ./data/configuration/DisclosureChecklist__c.json
+    Fetched 144 records of tffa__DisclosureMatrix__c
+    Writing 144 records to ./data/configuration/DisclosureMatrix__c.json
+    `
+  ]
+};

package/oclif.manifest.json CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":"16.0.0-rc.1","commands":{"tffa:apexdoc":{"id":"tffa:apexdoc","description":"Generate Apex API Documentation","strict":true,"usage":"<%= command.id %> [-s <directory>] [-d <directory>] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["Generate Apex API Documentation :\t$sfdx tffa:apexdoc "],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"sourcefolder":{"name":"sourcefolder","type":"option","char":"s","description":"directory containing sfdx project","multiple":false,"default":"."},"destfolder":{"name":"destfolder","type":"option","char":"d","description":"directory to generate the api docs","multiple":false}},"args":[],"flagsConfig":{"sourcefolder":{"kind":"directory","char":"s","description":"directory containing sfdx project","default":".","input":[],"multiple":false,"type":"option"},"destfolder":{"kind":"directory","char":"d","description":"directory to generate the api docs","input":[],"multiple":false,"type":"option"}}},"tffa:lint":{"id":"tffa:lint","description":"scan a sfdx project and provide a violations report based on defined standards","strict":true,"usage":"<%= command.id %> [-s <directory>] [-m <integer>] [-r <filepath>] [-e] [-f] [-j] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$sfdx tffa:lint"],"flags":{"json":{"name":"json","type":"boolean","char":"j","description":"generate json output","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"sourcefolder":{"name":"sourcefolder","type":"option","char":"s","description":"directory containing sfdx project","multiple":false,"default":"."},"minapi":{"name":"minapi","type":"option","char":"m","description":"minimum api version to use during quality checks","multiple":false,"default":56},"rulesetpath":{"name":"rulesetpath","type":"option","char":"r","description":"path to pmd ruleset","multiple":false},"eject":{"name":"eject","type":"boolean","char":"e","description":"update local pmd ruleset","allowNo":false},"level":{"name":"level","type":"boolean","char":"f","description":"emit fatal violations only","allowNo":false}},"args":[],"flagsConfig":{"sourcefolder":{"kind":"directory","char":"s","description":"directory containing sfdx project","default":".","input":[],"multiple":false,"type":"option"},"minapi":{"kind":"integer","char":"m","description":"minimum api version to use during quality checks","default":56,"input":[],"multiple":false,"type":"option"},"json":{"kind":"boolean","char":"j","description":"generate json output","allowNo":false,"type":"boolean"},"rulesetpath":{"kind":"filepath","char":"r","description":"path to pmd ruleset","input":[],"multiple":false,"type":"option"},"eject":{"kind":"boolean","char":"e","description":"update local pmd ruleset","allowNo":false,"type":"boolean"},"level":{"kind":"boolean","char":"f","description":"emit fatal violations only","allowNo":false,"type":"boolean"}}},"tffa:meta":{"id":"tffa:meta","description":"scan a sfdx project for metadata","strict":true,"usage":"<%= command.id %> [-s <directory>] [-d <directory>] [-c <directory>] [-o json\|csv\|human] [-f] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["scan a sfdx project for metadata :\t$sfdx tffa:meta"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"sourcefolder":{"name":"sourcefolder","type":"option","char":"s","description":"directory containing sfdx project","multiple":false,"default":"."},"destpath":{"name":"destpath","type":"option","char":"d","description":"full path output file","multiple":false,"default":"."},"clientname":{"name":"clientname","type":"option","char":"c","description":"name of the client","multiple":false,"default":"."},"output":{"name":"output","type":"option","char":"o","description":"output format json csv human","helpValue":"(json\|csv\|human)","multiple":false,"options":["json","csv","human"]},"fields":{"name":"fields","type":"boolean","char":"f","description":"generate field output","allowNo":false}},"args":[],"flagsConfig":{"sourcefolder":{"kind":"directory","char":"s","description":"directory containing sfdx project","default":".","input":[],"multiple":false,"type":"option"},"destpath":{"kind":"directory","char":"d","description":"full path output file","default":".","input":[],"multiple":false,"type":"option"},"clientname":{"kind":"directory","char":"c","description":"name of the client","default":".","input":[],"multiple":false,"type":"option"},"output":{"kind":"enum","helpValue":"(json\|csv\|human)","char":"o","options":["json","csv","human"],"description":"output format json csv human","input":[],"multiple":false,"type":"option"},"fields":{"kind":"boolean","char":"f","description":"generate field output","allowNo":false,"type":"boolean"}}},"tffa:ping":{"id":"tffa:ping","description":"ping and test the plugin","strict":true,"usage":"<%= command.id %> [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx tffa:ping "],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"}},"args":[{"name":"file"}],"flagsConfig":{}},"tffa:source:apiset":{"id":"tffa:source:apiset","description":"Upgrades the current project and all metadata to the latest API version","strict":true,"usage":"<%= command.id %> [-h <help>] [-s <directory>] [-a <integer>] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx tffa:source:apiset "],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"sourcefolder":{"name":"sourcefolder","type":"option","char":"s","description":"directory containing sfdx project","multiple":false,"default":"."},"api":{"name":"api","type":"option","char":"a","description":"specify the API version ","multiple":false,"default":56}},"args":[],"flagsConfig":{"help":{"kind":"help","description":"Show CLI help.","char":"h","allowNo":false,"type":"boolean"},"sourcefolder":{"kind":"directory","char":"s","description":"directory containing sfdx project","default":".","input":[],"multiple":false,"type":"option"},"api":{"kind":"integer","char":"a","description":"specify the API version ","default":56,"input":[],"multiple":false,"type":"option"}}}}}
1	+ {"version":"16.0.0-rc.2","commands":{"tffa:apexdoc":{"id":"tffa:apexdoc","description":"Generate Apex API Documentation","strict":true,"usage":"<%= command.id %> [-s <directory>] [-d <directory>] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["Generate Apex API Documentation :\t$sfdx tffa:apexdoc "],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"sourcefolder":{"name":"sourcefolder","type":"option","char":"s","description":"directory containing sfdx project","multiple":false,"default":"."},"destfolder":{"name":"destfolder","type":"option","char":"d","description":"directory to generate the api docs","multiple":false}},"args":[],"flagsConfig":{"sourcefolder":{"kind":"directory","char":"s","description":"directory containing sfdx project","default":".","input":[],"multiple":false,"type":"option"},"destfolder":{"kind":"directory","char":"d","description":"directory to generate the api docs","input":[],"multiple":false,"type":"option"}}},"tffa:lint":{"id":"tffa:lint","description":"scan a sfdx project and provide a violations report based on defined standards","strict":true,"usage":"<%= command.id %> [-s <directory>] [-m <integer>] [-r <filepath>] [-e] [-f] [-j] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$sfdx tffa:lint"],"flags":{"json":{"name":"json","type":"boolean","char":"j","description":"generate json output","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"sourcefolder":{"name":"sourcefolder","type":"option","char":"s","description":"directory containing sfdx project","multiple":false,"default":"."},"minapi":{"name":"minapi","type":"option","char":"m","description":"minimum api version to use during quality checks","multiple":false,"default":56},"rulesetpath":{"name":"rulesetpath","type":"option","char":"r","description":"path to pmd ruleset","multiple":false},"eject":{"name":"eject","type":"boolean","char":"e","description":"update local pmd ruleset","allowNo":false},"level":{"name":"level","type":"boolean","char":"f","description":"emit fatal violations only","allowNo":false}},"args":[],"flagsConfig":{"sourcefolder":{"kind":"directory","char":"s","description":"directory containing sfdx project","default":".","input":[],"multiple":false,"type":"option"},"minapi":{"kind":"integer","char":"m","description":"minimum api version to use during quality checks","default":56,"input":[],"multiple":false,"type":"option"},"json":{"kind":"boolean","char":"j","description":"generate json output","allowNo":false,"type":"boolean"},"rulesetpath":{"kind":"filepath","char":"r","description":"path to pmd ruleset","input":[],"multiple":false,"type":"option"},"eject":{"kind":"boolean","char":"e","description":"update local pmd ruleset","allowNo":false,"type":"boolean"},"level":{"kind":"boolean","char":"f","description":"emit fatal violations only","allowNo":false,"type":"boolean"}}},"tffa:meta":{"id":"tffa:meta","description":"scan a sfdx project for metadata","strict":true,"usage":"<%= command.id %> [-s <directory>] [-d <directory>] [-c <directory>] [-o json\|csv\|human] [-f] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["scan a sfdx project for metadata :\t$sfdx tffa:meta"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"sourcefolder":{"name":"sourcefolder","type":"option","char":"s","description":"directory containing sfdx project","multiple":false,"default":"."},"destpath":{"name":"destpath","type":"option","char":"d","description":"full path output file","multiple":false,"default":"."},"clientname":{"name":"clientname","type":"option","char":"c","description":"name of the client","multiple":false,"default":"."},"output":{"name":"output","type":"option","char":"o","description":"output format json csv human","helpValue":"(json\|csv\|human)","multiple":false,"options":["json","csv","human"]},"fields":{"name":"fields","type":"boolean","char":"f","description":"generate field output","allowNo":false}},"args":[],"flagsConfig":{"sourcefolder":{"kind":"directory","char":"s","description":"directory containing sfdx project","default":".","input":[],"multiple":false,"type":"option"},"destpath":{"kind":"directory","char":"d","description":"full path output file","default":".","input":[],"multiple":false,"type":"option"},"clientname":{"kind":"directory","char":"c","description":"name of the client","default":".","input":[],"multiple":false,"type":"option"},"output":{"kind":"enum","helpValue":"(json\|csv\|human)","char":"o","options":["json","csv","human"],"description":"output format json csv human","input":[],"multiple":false,"type":"option"},"fields":{"kind":"boolean","char":"f","description":"generate field output","allowNo":false,"type":"boolean"}}},"tffa:ping":{"id":"tffa:ping","description":"ping and test the plugin","strict":true,"usage":"<%= command.id %> [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx tffa:ping "],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"}},"args":[{"name":"file"}],"flagsConfig":{}},"tffa:data:export":{"id":"tffa:data:export","description":"Exports records of specified sobject types from target org into JSON file(s). Primarily used for exporting business configurations.\nThe export command requires a target org for exporting records. Run this command from within a sfdx project containing a default username or specify targetusername explicitly.","strict":true,"usage":"<%= command.id %> -s <array> [-d <string>] [-g <string>] [-o <array>] [-c <array>] [-s] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx tffa:data:export --sobjecttype tffa__Product__c\n Fetched 101 records of tffa__Product__c\n Writing 24 records to ./data/configuration/Product__c.json\n Writing 30 records to ./data/configuration/Product__c1.json\n Writing 20 records to ./data/configuration/Product__c2.json\n Writing 27 records to ./data/configuration/Product__c3.json\n ","$ sfdx tffa:data:export --sobjecttype tffa__DisclosureTemplate__c,tffa__DisclosureChecklist__c,tffa__DisclosureMatrix__c\n Fetched 81 records of tffa__DisclosureTemplate__c\n Writing 81 records to ./data/configuration/DisclosureTemplate__c.json\n Fetched 57 records of tffa__DisclosureChecklist__c\n Writing 57 records to ./data/configuration/DisclosureChecklist__c.json\n Fetched 144 records of tffa__DisclosureMatrix__c\n Writing 144 records to ./data/configuration/DisclosureMatrix__c.json\n "],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"sobject types of records to be exported","required":true,"multiple":false},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory where the JSON files of exported records will be placed","multiple":false,"default":"./data/configuration"},"groupby":{"name":"groupby","type":"option","char":"g","description":"the field to be used for grouping the exported records; records belonging to each group are placed in separate JSON files (filename suffixed by group name)","required":false,"multiple":false},"orderby":{"name":"orderby","type":"option","char":"o","description":"the fields to be used for sorting the exported records","required":false,"multiple":false},"children":{"name":"children","type":"option","char":"c","description":"the child relationships to be included in the exported records; this is not required for tffa package objects. e.g. tffa__Features__r,tffa__Terms__r child relationships are auto included when running export command for tffa__Product__c","required":false,"multiple":false},"skipconfigplan":{"name":"skipconfigplan","type":"boolean","char":"s","description":"skip import of exported record JSON files into configuration plan","required":false,"allowNo":false}},"args":[],"requiresUsername":true,"flagsConfig":{"sobjecttype":{"kind":"array","char":"s","required":true,"description":"sobject types of records to be exported","input":[],"multiple":false,"type":"option"},"outputdir":{"kind":"string","char":"d","description":"output directory where the JSON files of exported records will be placed","default":"./data/configuration","input":[],"multiple":false,"type":"option"},"groupby":{"kind":"string","char":"g","required":false,"description":"the field to be used for grouping the exported records; records belonging to each group are placed in separate JSON files (filename suffixed by group name)","input":[],"multiple":false,"type":"option"},"orderby":{"kind":"array","char":"o","required":false,"description":"the fields to be used for sorting the exported records","input":[],"multiple":false,"type":"option"},"children":{"kind":"array","char":"c","required":false,"description":"the child relationships to be included in the exported records; this is not required for tffa package objects. e.g. tffa__Features__r,tffa__Terms__r child relationships are auto included when running export command for tffa__Product__c","input":[],"multiple":false,"type":"option"},"skipconfigplan":{"kind":"boolean","char":"s","required":false,"description":"skip import of exported record JSON files into configuration plan","allowNo":false,"type":"boolean"}}},"tffa:source:apiset":{"id":"tffa:source:apiset","description":"Upgrades the current project and all metadata to the latest API version","strict":true,"usage":"<%= command.id %> [-h <help>] [-s <directory>] [-a <integer>] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]","pluginName":"@terafina/tffa-sfdx-plugin","pluginAlias":"@terafina/tffa-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx tffa:source:apiset "],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"sourcefolder":{"name":"sourcefolder","type":"option","char":"s","description":"directory containing sfdx project","multiple":false,"default":"."},"api":{"name":"api","type":"option","char":"a","description":"specify the API version ","multiple":false,"default":56}},"args":[],"flagsConfig":{"help":{"kind":"help","description":"Show CLI help.","char":"h","allowNo":false,"type":"boolean"},"sourcefolder":{"kind":"directory","char":"s","description":"directory containing sfdx project","default":".","input":[],"multiple":false,"type":"option"},"api":{"kind":"integer","char":"a","description":"specify the API version ","default":56,"input":[],"multiple":false,"type":"option"}}}}}

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@terafina/tffa-sfdx-plugin",
   "description": "sfdx plugin from Terafina containing tools for scanning and extending digital applications for the financial services industry.",
-  "version": "16.0.0-rc.1",
+  "version": "16.0.0-rc.2",
   "author": "Terafina Inc",
   "bugs": "https://github.com/terafinainc/tffa-sfdx-plugin/issues",
   "dependencies": {