@salesforce/source-testkit 0.0.17 → 1.0.1

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.0.1](https://github.com/salesforcecli/source-testkit/compare/v1.0.0...v1.0.1) (2022-05-31)
+
+### Bug Fixes
+
+- support multiple plugin-config versions ([#78](https://github.com/salesforcecli/source-testkit/issues/78)) ([365831f](https://github.com/salesforcecli/source-testkit/commit/365831f5de5f489d2f2065230e8847de1ecf4f0b))
+
+## [1.0.0](https://github.com/salesforcecli/source-testkit/compare/v0.0.18...v1.0.0) (2022-05-31)
+
+### Features
+
+- use parking-orbit newer core/sdr ([#77](https://github.com/salesforcecli/source-testkit/issues/77)) ([d9ed642](https://github.com/salesforcecli/source-testkit/commit/d9ed642003bb85407a7b17ffa7b64764eb81b488))
+
+### [0.0.18](https://github.com/salesforcecli/source-testkit/compare/v0.0.17...v0.0.18) (2022-03-08)
+
+### Features
+
+- make type changes to make testing sf easier ([#59](https://github.com/salesforcecli/source-testkit/issues/59)) ([7752ed6](https://github.com/salesforcecli/source-testkit/commit/7752ed66eff3be11c9fa6921223f277427334fab))
+
 ### [0.0.17](https://github.com/salesforcecli/source-testkit/compare/v0.0.16...v0.0.17) (2022-02-12)
 
 ### [0.0.16](https://github.com/salesforcecli/source-testkit/compare/v0.0.15...v0.0.16) (2021-10-13)

package/lib/assertions.js

@@ -1,21 +1,21 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Assertions = void 0;
 /*
  * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Assertions = void 0;
+const fs = require("fs");
 const path = require("path");
 const chai_1 = require("chai");
 const chaiEach = require("chai-each");
 const fg = require("fast-glob");
-const core_1 = require("@salesforce/core");
 const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const debug_1 = require("debug");
 const fileTracker_1 = require("./fileTracker");
-chai_1.use(chaiEach);
+(0, chai_1.use)(chaiEach);
 /**
  * Assertions is a class that is designed to encapsulate common assertions we want to
  * make during NUT testings
@@ -31,7 +31,7 @@ class Assertions {
         this.projectDir = context.projectDir;
         this.connection = context.connection;
         this.commands = context.commands;
-        this.debug = debug_1.debug(`assertions:${context.nut}`);
+        this.debug = (0, debug_1.debug)(`assertions:${context.nut}`);
         this.metadataResolver = new source_deploy_retrieve_1.MetadataResolver();
     }
     /**
@@ -39,14 +39,14 @@ class Assertions {
      */
     fileToBeChanged(file) {
         const fileHistory = this.fileTracker.getLatest(file);
-        chai_1.expect(fileHistory === null || fileHistory === void 0 ? void 0 : fileHistory.changedFromPrevious, 'File to be changed').to.be.true;
+        (0, chai_1.expect)(fileHistory === null || fileHistory === void 0 ? void 0 : fileHistory.changedFromPrevious, 'File to be changed').to.be.true;
     }
     /**
      * Expect given file to NOT be changed according to the file history provided by FileTracker
      */
     fileToNotBeChanged(file) {
         const fileHistory = this.fileTracker.getLatest(file);
-        chai_1.expect(fileHistory === null || fileHistory === void 0 ? void 0 : fileHistory.changedFromPrevious, 'File to NOT be changed').to.be.false;
+        (0, chai_1.expect)(fileHistory === null || fileHistory === void 0 ? void 0 : fileHistory.changedFromPrevious, 'File to NOT be changed').to.be.false;
     }
     /**
      * Expect all files found by globs to be changed according to the file history provided by FileTracker
@@ -62,9 +62,9 @@ class Assertions {
             .filter((f) => !f.endsWith('.resource'))
             .map((f) => this.fileTracker.getLatest(path.normalize(f)))
             .filter((f) => !!f);
-        chai_1.expect(fileHistories, 'file history to exist for tracked files').length.to.be.greaterThan(0);
+        (0, chai_1.expect)(fileHistories, 'file history to exist for tracked files').length.to.be.greaterThan(0);
         const allChanged = fileHistories.every((f) => f === null || f === void 0 ? void 0 : f.changedFromPrevious);
-        chai_1.expect(allChanged, 'all files to be changed').to.be.true;
+        (0, chai_1.expect)(allChanged, 'all files to be changed').to.be.true;
     }
     /**
      * Expect all files found by globs to NOT be changed according to the file history provided by FileTracker
@@ -77,9 +77,9 @@ class Assertions {
             .filter((f) => !f.endsWith('.resource-meta.xml'))
             .map((f) => this.fileTracker.getLatest(f))
             .filter((f) => !!f);
-        chai_1.expect(fileHistories, 'file history to exist for tracked files').length.to.be.greaterThan(0);
+        (0, chai_1.expect)(fileHistories, 'file history to exist for tracked files').length.to.be.greaterThan(0);
         const allChanged = fileHistories.every((f) => f === null || f === void 0 ? void 0 : f.changedFromPrevious);
-        chai_1.expect(allChanged, 'all files to NOT be changed').to.be.false;
+        (0, chai_1.expect)(allChanged, 'all files to NOT be changed').to.be.false;
     }
     /**
      * Finds all files in project based on the provided globs and expects them to be updated on the server
@@ -102,7 +102,7 @@ class Assertions {
         // glob will return files with '/' as separators, this won't work on Windows
         const toTrack = all.filter((file) => !ignoreFiles.includes(file)).map((file) => file.replace(/\//g, path.sep));
         result.map((source) => {
-            chai_1.expect(toTrack, `toTrack: ${toTrack.join('\n')}, missing file : ${source.filePath}`).to.include(source.filePath);
+            (0, chai_1.expect)(toTrack, `toTrack: ${toTrack.join('\n')}, missing file : ${source.filePath}`).to.include(source.filePath);
         });
     }
     /**
@@ -123,8 +123,8 @@ class Assertions {
      */
     async fileToExist(file) {
         const fullPath = file.startsWith(this.projectDir) ? file : path.join(this.projectDir, file);
-        const fileExists = await core_1.fs.fileExists(fullPath);
-        chai_1.expect(fileExists, `${fullPath} to exist`).to.be.true;
+        const fileExists = fs.existsSync(fullPath);
+        (0, chai_1.expect)(fileExists, `${fullPath} to exist`).to.be.true;
     }
     /**
      * Expects given globs to return files
@@ -132,7 +132,7 @@ class Assertions {
     async filesToExist(globs) {
         for (const glob of globs) {
             const results = await this.doGlob([glob]);
-            chai_1.expect(results.length, `expect files to be found by glob: ${glob}`).to.be.greaterThan(0);
+            (0, chai_1.expect)(results.length, `expect files to be found by glob: ${glob}`).to.be.greaterThan(0);
         }
     }
     /**
@@ -141,7 +141,7 @@ class Assertions {
     async filesToNotExist(globs) {
         for (const glob of globs) {
             const results = await this.doGlob([glob], false);
-            chai_1.expect(results.length, `expect no files to be found by glob: ${glob}`).to.equal(0);
+            (0, chai_1.expect)(results.length, `expect no files to be found by glob: ${glob}`).to.equal(0);
         }
     }
     /**
@@ -151,7 +151,7 @@ class Assertions {
         directory = directory.split(path.sep).join('/');
         const fullGlobs = globs.map((glob) => [directory, glob].join('/'));
         const convertedFiles = await fg(fullGlobs);
-        chai_1.expect(convertedFiles.length, 'files to be converted').to.be.greaterThan(0);
+        (0, chai_1.expect)(convertedFiles.length, 'files to be converted').to.be.greaterThan(0);
     }
     /**
      * Expects files found by glob to not contain any of the provided strings
@@ -159,9 +159,9 @@ class Assertions {
     async filesToNotContainString(glob, ...strings) {
         const files = await this.doGlob([glob]);
         for (const file of files) {
-            const contents = await core_1.fs.readFile(file, 'UTF-8');
+            const contents = await fs.promises.readFile(file, 'utf-8');
             for (const str of strings) {
-                chai_1.expect(contents, `expect ${file} to not include ${str}`).to.not.include(str);
+                (0, chai_1.expect)(contents, `expect ${file} to not include ${str}`).to.not.include(str);
             }
         }
     }
@@ -171,9 +171,9 @@ class Assertions {
     async filesToContainString(glob, ...strings) {
         const files = await this.doGlob([glob]);
         for (const file of files) {
-            const contents = await core_1.fs.readFile(file, 'UTF-8');
+            const contents = await fs.promises.readFile(file, 'utf-8');
             for (const str of strings) {
-                chai_1.expect(contents, `expect ${file} to not include ${str}`).to.include(str);
+                (0, chai_1.expect)(contents, `expect ${file} to not include ${str}`).to.include(str);
             }
         }
     }
@@ -197,14 +197,14 @@ class Assertions {
      */
     async directoryToHaveSomeFiles(directory) {
         const fullPath = directory.startsWith(this.projectDir) ? directory : path.join(this.projectDir, directory);
-        const fileCount = await fileTracker_1.countFiles([fullPath]);
-        chai_1.expect(fileCount, `at least 1 file found in ${directory}`).to.be.greaterThan(0);
+        const fileCount = await (0, fileTracker_1.countFiles)([fullPath]);
+        (0, chai_1.expect)(fileCount, `at least 1 file found in ${directory}`).to.be.greaterThan(0);
     }
     /**
      * Expect status to return no results
      */
     statusToBeEmpty(result) {
-        chai_1.expect(result.length, 'status to have no results').to.equal(0);
+        (0, chai_1.expect)(result.length, 'status to have no results').to.equal(0);
     }
     /**
      * Expect all given files to have the given state
@@ -213,36 +213,36 @@ class Assertions {
         for (const file of files) {
             this.statusFileToHaveState(result, state, file);
         }
-        chai_1.expect(result.length, 'all files to be present in json response').to.equal(files.length);
+        (0, chai_1.expect)(result.length, 'all files to be present in json response').to.equal(files.length);
     }
     /**
      * Expect given file to have the given state
      */
     statusFileToHaveState(result, state, file) {
         const expectedFile = result.find((r) => r.filePath === file);
-        chai_1.expect(expectedFile, `${file} to be present in json response`).to.not.be.undefined;
-        chai_1.expect(expectedFile === null || expectedFile === void 0 ? void 0 : expectedFile.state, `${file} to have state ${state}`).to.equal(state);
+        (0, chai_1.expect)(expectedFile, `${file} to be present in json response`).to.not.be.undefined;
+        (0, chai_1.expect)(expectedFile === null || expectedFile === void 0 ? void 0 : expectedFile.state, `${file} to have state ${state}`).to.equal(state);
     }
     /**
      * Expect all given files to have the given state
      */
     statusToOnlyHaveState(result, state) {
         const allStates = result.every((r) => r.state === state);
-        chai_1.expect(allStates, `all files to have ${state}`).to.be.true;
+        (0, chai_1.expect)(allStates, `all files to have ${state}`).to.be.true;
     }
     /**
      * Expect all files to have a conflict state
      */
     statusToOnlyHaveConflicts(result) {
         const allConflicts = result.every((r) => r.state.includes('Conflict'));
-        chai_1.expect(allConflicts, 'all results to show conflict state').to.be.true;
+        (0, chai_1.expect)(allConflicts, 'all results to show conflict state').to.be.true;
     }
     /**
      * Expect json to have given error name
      */
     errorToHaveName(result, name) {
-        chai_1.expect(result).to.have.property('name');
-        chai_1.expect(result.name, `error name to equal ${name}`).to.equal(name);
+        (0, chai_1.expect)(result).to.have.property('name');
+        (0, chai_1.expect)(result.name, `error name to equal ${name}`).to.equal(name);
     }
     /**
      * Expect no apex tests to be run
@@ -251,7 +251,7 @@ class Assertions {
         const executionTimestamp = this.executionLog.getLatestTimestamp(this.commands.deploy);
         const testResults = await this.retrieveApexTestResults();
         const testsRunAfterTimestamp = testResults.filter((r) => new Date(r.TestTimestamp) > executionTimestamp);
-        chai_1.expect(testsRunAfterTimestamp.length, 'no tests to be run during deploy').to.equal(0);
+        (0, chai_1.expect)(testsRunAfterTimestamp.length, 'no tests to be run during deploy').to.equal(0);
     }
     /**
      * Expect some apex tests to be run
@@ -260,7 +260,7 @@ class Assertions {
         const executionTimestamp = this.executionLog.getLatestTimestamp(this.commands.deploy);
         const testResults = await this.retrieveApexTestResults();
         const testsRunAfterTimestamp = testResults.filter((r) => new Date(r.TestTimestamp) > executionTimestamp);
-        chai_1.expect(testsRunAfterTimestamp.length, 'tests to be run during deploy').to.be.greaterThan(0);
+        (0, chai_1.expect)(testsRunAfterTimestamp.length, 'tests to be run during deploy').to.be.greaterThan(0);
     }
     /**
      * Expect apex tests owned by the provided classes to be run
@@ -273,27 +273,27 @@ class Assertions {
         const testsRunAfterTimestamp = testResults.filter((r) => {
             return new Date(r.TestTimestamp) > executionTimestamp && classIds.includes(r.ApexClassId);
         });
-        chai_1.expect(testsRunAfterTimestamp.length, 'tests to be run during deploy').to.be.greaterThan(0);
+        (0, chai_1.expect)(testsRunAfterTimestamp.length, 'tests to be run during deploy').to.be.greaterThan(0);
     }
     /**
      * Expect result to have given property
      */
     toHaveProperty(result, prop) {
-        chai_1.expect(result).to.have.property(prop);
+        (0, chai_1.expect)(result).to.have.property(prop);
     }
     /**
      * Expect result to have given property and for that property to equal the given value
      */
     toHavePropertyAndValue(result, prop, value) {
-        chai_1.expect(result).to.have.property(prop);
-        chai_1.expect(result[prop], `${prop} to have value ${value.toString()}`).to.equal(value);
+        (0, chai_1.expect)(result).to.have.property(prop);
+        (0, chai_1.expect)(result[prop], `${prop} to have value ${value.toString()}`).to.equal(value);
     }
     /**
      * Expect result to have given property and for that property to NOT equal the given value
      */
     toHavePropertyAndNotValue(result, prop, value) {
-        chai_1.expect(result).to.have.property(prop);
-        chai_1.expect(result[prop], `${prop} to have value that does not equal ${value.toString()}`).to.not.equal(value);
+        (0, chai_1.expect)(result).to.have.property(prop);
+        (0, chai_1.expect)(result[prop], `${prop} to have value that does not equal ${value.toString()}`).to.not.equal(value);
     }
     async filesToBeUpdated(globs, ignore = [], command) {
         var _a;
@@ -302,7 +302,7 @@ class Assertions {
         for (const sourceMember of latestSourceMembers) {
             const assertionMessage = `expect RevisionCounter for ${sourceMember.MemberName} (${sourceMember.MemberType}) to be incremented`;
             const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) || { RevisionCounter: 0 };
-            chai_1.expect(sourceMember.RevisionCounter, assertionMessage).to.be.greaterThan(preCommandExecution.RevisionCounter);
+            (0, chai_1.expect)(sourceMember.RevisionCounter, assertionMessage).to.be.greaterThan(preCommandExecution.RevisionCounter);
         }
     }
     async filesToNotBeUpdated(globs, ignore = [], command) {
@@ -313,13 +313,13 @@ class Assertions {
             // Not finding any source members based on the globs means that there is no SourceMember for those files
             // which we're assuming means that it hasn't been deployed to the org yet.
             // That's acceptable for this test since we're testing that metadata hasn't been deployed.
-            chai_1.expect(latestSourceMembers.length).to.equal(0);
+            (0, chai_1.expect)(latestSourceMembers.length).to.equal(0);
         }
         else {
             for (const sourceMember of latestSourceMembers) {
                 const assertionMessage = `expect RevisionCounter for ${sourceMember.MemberName} (${sourceMember.MemberType}) to NOT be incremented`;
                 const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) || { RevisionCounter: 0 };
-                chai_1.expect(sourceMember.RevisionCounter, assertionMessage).to.equal(preCommandExecution.RevisionCounter);
+                (0, chai_1.expect)(sourceMember.RevisionCounter, assertionMessage).to.equal(preCommandExecution.RevisionCounter);
             }
         }
     }
@@ -331,7 +331,7 @@ class Assertions {
             const preCommandExecution = sourceMembers.find((s) => s.MemberType === sourceMember.MemberType && s.MemberName === sourceMember.MemberName) || { RevisionCounter: 0 };
             return sourceMember.RevisionCounter === preCommandExecution.RevisionCounter;
         });
-        chai_1.expect(someAreNotUpdated, 'expect some SourceMembers to not be updated').to.be.true;
+        (0, chai_1.expect)(someAreNotUpdated, 'expect some SourceMembers to not be updated').to.be.true;
     }
     async retrieveSourceMembers(globs, ignore = []) {
         var _a;
@@ -395,7 +395,7 @@ class Assertions {
             files.push(...globResults);
         }
         if (assert)
-            chai_1.expect(files.length, 'globs to return files').to.be.greaterThan(0);
+            (0, chai_1.expect)(files.length, 'globs to return files').to.be.greaterThan(0);
         return files;
     }
 }

package/lib/executionLog.js

@@ -22,7 +22,7 @@ class ExecutionLog {
      * Add a command to the execution log
      */
     async add(cmd) {
-        const baseCmd = ts_types_1.ensureString(Object.values(this.context.commands).find((c) => cmd.startsWith(c)) || cmd.split(' -')[0]);
+        const baseCmd = (0, ts_types_1.ensureString)(Object.values(this.context.commands).find((c) => cmd.startsWith(c)) || cmd.split(' -')[0]);
         const existingEntries = this.log.get(baseCmd) || [];
         const sourceMembers = baseCmd.includes(this.context.commands.deploy) || baseCmd.includes(this.context.commands.push)
             ? await this.querySourceMembers()

package/lib/fileTracker.js

@@ -1,14 +1,15 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.countFiles = exports.traverseForFiles = exports.FileTracker = void 0;
 /*
  * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.countFiles = exports.traverseForFiles = exports.FileTracker = void 0;
+const fs = require("fs");
 const path = require("path");
-const core_1 = require("@salesforce/core");
+const crypto = require("crypto");
 /**
  * This class maintains a map of tracked files. This is particularly useful
  * for determining if files have changed after a command has been executed
@@ -76,10 +77,12 @@ class FileTracker {
     async getContentHash(file) {
         const filePath = this.getFullPath(file);
         try {
-            const filestat = await core_1.fs.stat(filePath);
+            const filestat = await fs.promises.stat(filePath);
             const isDirectory = filestat.isDirectory();
-            const contents = isDirectory ? (await core_1.fs.readdir(filePath)).toString() : await core_1.fs.readFile(filePath);
-            return core_1.fs.getContentHash(contents);
+            const contents = isDirectory
+                ? (await fs.promises.readdir(filePath)).toString()
+                : await fs.promises.readFile(filePath);
+            return crypto.createHash('sha1').update(contents).digest('hex');
         }
         catch {
             return null;
@@ -94,10 +97,10 @@ exports.FileTracker = FileTracker;
  * Returns all files in directory that match the filter
  */
 async function traverseForFiles(dirPath, regexFilter = /./, allFiles = []) {
-    const files = await core_1.fs.readdir(dirPath);
+    const files = await fs.promises.readdir(dirPath);
     for (const file of files) {
         const filePath = path.join(dirPath, file);
-        if (core_1.fs.statSync(filePath).isDirectory()) {
+        if (fs.statSync(filePath).isDirectory()) {
             allFiles = await traverseForFiles(filePath, regexFilter, allFiles);
         }
         else if (regexFilter.test(file)) {

package/lib/testkit.d.ts

@@ -58,9 +58,9 @@ export declare class SourceTestkit extends AsyncCreatable<SourceTestkit.Options>
     /**
      * Executes force:source:deploy
      */
-    deploy(options?: Partial<SourceTestkit.CommandOpts>): Promise<Result<{
+    deploy<T = {
         id: string;
-    }>>;
+    }>(options?: Partial<SourceTestkit.CommandOpts>): Promise<Result<T>>;
     /**
      * Executes force:source:deploy:report
      */
@@ -199,7 +199,7 @@ export declare class SourceTestkit extends AsyncCreatable<SourceTestkit.Options>
      */
     spoofRemoteChange(globs: string[]): Promise<void>;
     /**
-     * Returns true if the executable being used belongs to a local pacakage
+     * Returns true if the executable being used belongs to a local package
      */
     isLocalExecutable(): boolean;
     /**

package/lib/testkit.js

@@ -10,6 +10,7 @@ exports.COMMANDS = exports.Executable = exports.SourceTestkit = void 0;
 /* eslint-disable no-console */
 const path = require("path");
 const os = require("os");
+const fs = require("fs");
 const fg = require("fast-glob");
 const shelljs_1 = require("shelljs");
 const cli_plugins_testkit_1 = require("@salesforce/cli-plugins-testkit");
@@ -39,13 +40,14 @@ const fileTracker_1 = require("./fileTracker");
  */
 class SourceTestkit extends kit_1.AsyncCreatable {
     constructor(options) {
+        var _a, _b, _c;
         super(options);
-        this.executable = options.executable || shelljs_1.which('sfdx').stdout;
+        this.executable = (_c = (_a = options.executable) !== null && _a !== void 0 ? _a : (_b = (0, shelljs_1.which)('sfdx')) === null || _b === void 0 ? void 0 : _b.stdout) !== null && _c !== void 0 ? _c : 'sfdx';
         this.repository = options.repository;
         this.orgless = !!options.orgless;
         this.setupCommands = options.setupCommands || [];
         this.nut = path.basename(options.nut);
-        this.debug = debug_1.debug(`sourceTestkit:${this.nut}`);
+        this.debug = (0, debug_1.debug)(`sourceTestkit:${this.nut}`);
     }
     /**
      * Cleans the test session
@@ -120,7 +122,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      * we can't add plugin-package as a dev plugin yet.
      */
     installPackage(id) {
-        shelljs_1.exec(`sfdx force:package:install --noprompt --package ${id} --wait 5 --json 2> /dev/null`, { silent: true });
+        (0, shelljs_1.exec)(`sfdx force:package:install --noprompt --package ${id} --wait 5 --json 2> /dev/null`, { silent: true });
     }
     /**
      * Runs the permset:assign command with the passed in options
@@ -154,7 +156,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
         const files = await this.doGlob(globs);
         const returnValue = {};
         for (const file of files) {
-            returnValue[file] = await core_1.fs.readFile(file, 'UTF-8');
+            returnValue[file] = await fs.promises.readFile(file, 'utf8');
         }
         return returnValue;
     }
@@ -163,27 +165,27 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      */
     async readSourcePathInfos() {
         const sourcePathInfosPath = path.join(this.projectDir, '.sfdx', 'orgs', this.username, 'sourcePathInfos.json');
-        return core_1.fs.readJson(sourcePathInfosPath);
+        return JSON.parse(await fs.promises.readFile(sourcePathInfosPath, 'utf8'));
     }
     /**
      * Read the org's maxRevision.json
      */
     async readMaxRevision() {
         const maxRevisionPath = path.join(this.projectDir, '.sfdx', 'orgs', this.username, 'maxRevision.json');
-        return core_1.fs.readJson(maxRevisionPath);
+        return JSON.parse(await fs.promises.readFile(maxRevisionPath, 'utf8'));
     }
     /**
      * Write the org's maxRevision.json
      */
     async writeMaxRevision(contents) {
         const maxRevisionPath = path.join(this.projectDir, '.sfdx', 'orgs', this.username, 'maxRevision.json');
-        return core_1.fs.writeJson(maxRevisionPath, contents);
+        return fs.promises.writeFile(maxRevisionPath, JSON.stringify(contents));
     }
     /**
      * Write file
      */
     async writeFile(filename, contents) {
-        return core_1.fs.writeFile(filename, contents);
+        return fs.promises.writeFile(filename, contents);
     }
     /**
      * Create a package.xml
@@ -196,7 +198,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
 </Package>
     `;
         const packageXmlPath = path.join(this.projectDir, 'package.xml');
-        await core_1.fs.writeFile(packageXmlPath, packageXml);
+        await fs.promises.writeFile(packageXmlPath, packageXml);
         return packageXmlPath;
     }
     /**
@@ -204,14 +206,14 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      */
     async deleteSourcePathInfos() {
         const sourcePathInfosPath = path.join(this.projectDir, '.sfdx', 'orgs', this.username, 'sourcePathInfos.json');
-        return core_1.fs.unlink(sourcePathInfosPath);
+        return fs.promises.unlink(sourcePathInfosPath);
     }
     /**
      * Delete the org's maxRevision.json
      */
     async deleteMaxRevision() {
         const maxRevisionPath = path.join(this.projectDir, '.sfdx', 'orgs', this.username, 'maxRevision.json');
-        return core_1.fs.unlink(maxRevisionPath);
+        return fs.promises.unlink(maxRevisionPath);
     }
     /**
      * Delete the files found by the given globs
@@ -219,7 +221,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
     async deleteGlobs(globs) {
         const files = await this.doGlob(globs);
         for (const file of files) {
-            await core_1.fs.unlink(file);
+            await fs.promises.unlink(file);
         }
     }
     /**
@@ -227,8 +229,8 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      */
     async deleteAllSourceFiles() {
         for (const pkg of this.packagePaths) {
-            await core_1.fs.rmdir(pkg, { recursive: true });
-            await core_1.fs.mkdirp(pkg);
+            await fs.promises.rm(pkg, { recursive: true });
+            await fs.promises.mkdir(pkg, { recursive: true });
         }
     }
     /**
@@ -245,9 +247,9 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      */
     async modifyLocalFile(file, append = os.EOL) {
         const fullPath = file.startsWith(this.projectDir) ? file : path.join(this.projectDir, file);
-        let contents = await core_1.fs.readFile(fullPath, 'UTF-8');
+        let contents = await fs.promises.readFile(fullPath, 'utf-8');
         contents += append;
-        await core_1.fs.writeFile(fullPath, contents);
+        await fs.promises.writeFile(fullPath, contents);
         await this.fileTracker.update(fullPath, 'modified file');
     }
     /**
@@ -276,11 +278,11 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             const src = path.join(this.testMetadataFolder, file);
             this.debug(`addTestFiles: ${src} -> ${dest}`);
             try {
-                core_1.fs.copyFileSync(src, dest);
+                fs.copyFileSync(src, dest);
             }
             catch {
-                await core_1.fs.mkdirp(path.dirname(dest));
-                core_1.fs.copyFileSync(src, dest);
+                await fs.promises.mkdir(path.dirname(dest), { recursive: true });
+                fs.copyFileSync(src, dest);
             }
         }
         await this.trackFiles(this.testMetadataFiles);
@@ -300,19 +302,19 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             const name = component.name;
             if (!type.includes('CustomLabel')) {
                 const maxRevisionKey = parent ? `${type}__${parent}.${name}` : `${type}__${name}`;
-                kit_1.set(maxRevision.sourceMembers, `${maxRevisionKey}.lastRetrievedFromServer`, null);
+                (0, kit_1.set)(maxRevision.sourceMembers, `${maxRevisionKey}.lastRetrievedFromServer`, null);
             }
             else {
                 const labels = Object.keys(maxRevision.sourceMembers).filter((k) => k.startsWith('CustomLabel'));
                 labels.forEach((label) => {
-                    kit_1.set(maxRevision.sourceMembers, `${label}.lastRetrievedFromServer`, null);
+                    (0, kit_1.set)(maxRevision.sourceMembers, `${label}.lastRetrievedFromServer`, null);
                 });
             }
         }
         await this.writeMaxRevision(maxRevision);
     }
     /**
-     * Returns true if the executable being used belongs to a local pacakage
+     * Returns true if the executable being used belongs to a local package
      */
     isLocalExecutable() {
         return (this.executable.endsWith(SourceTestkit.LocalDevPath) || this.executable.endsWith(SourceTestkit.LocalProdPath));
@@ -325,12 +327,12 @@ class SourceTestkit extends kit_1.AsyncCreatable {
      * dir, move it, and delete the generated dir.
      */
     findAndMoveManifest(dir) {
-        const manifest = shelljs_1.find(dir).filter((file) => file.endsWith('package.xml'));
+        const manifest = (0, shelljs_1.find)(dir).filter((file) => file.endsWith('package.xml'));
         if (!(manifest === null || manifest === void 0 ? void 0 : manifest.length)) {
             throw Error(`Did not find package.xml within ${dir}`);
         }
-        shelljs_1.mv(manifest[0], path.join(process.cwd()));
-        shelljs_1.rm('-rf', dir);
+        (0, shelljs_1.mv)(manifest[0], path.join(process.cwd()));
+        (0, shelljs_1.rm)('-rf', dir);
     }
     /**
      * Execute a command using testkit. Adds --json to every command to ensure json output.
@@ -343,10 +345,10 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             await this.fileTracker.updateAll(`PRE: ${command}`);
             await this.executionLog.add(command);
             const result = this.executableName === Executable.SF
-                ? cli_plugins_testkit_1.execCmd(command, { ensureExitCode: exitCode, cli: 'sf' })
-                : cli_plugins_testkit_1.execCmd(command, { ensureExitCode: exitCode, cli: 'sfdx' });
+                ? (0, cli_plugins_testkit_1.execCmd)(command, { ensureExitCode: exitCode, cli: 'sf' })
+                : (0, cli_plugins_testkit_1.execCmd)(command, { ensureExitCode: exitCode, cli: 'sfdx' });
             await this.fileTracker.updateAll(`POST: ${command}`);
-            if (json && this.executableName === Executable.SFDX) {
+            if (json) {
                 const jsonOutput = result.jsonOutput;
                 this.debug('%O', jsonOutput);
                 if (!jsonOutput) {
@@ -361,15 +363,6 @@ class SourceTestkit extends kit_1.AsyncCreatable {
                 }
                 return jsonOutput;
             }
-            if (json && this.executableName === Executable.SF) {
-                const jsonOutput = result.jsonOutput;
-                this.debug('%O', jsonOutput);
-                if (!jsonOutput) {
-                    console.error(`${command} returned null jsonOutput`);
-                    console.error(result);
-                }
-                return jsonOutput;
-            }
         }
         catch (err) {
             const error = err;
@@ -378,9 +371,9 @@ class SourceTestkit extends kit_1.AsyncCreatable {
     }
     async init() {
         if (!SourceTestkit.Env.getString('TESTKIT_HUB_USERNAME') && !SourceTestkit.Env.getString('TESTKIT_AUTH_URL')) {
-            ts_types_1.ensureString(SourceTestkit.Env.getString('TESTKIT_JWT_KEY'));
-            ts_types_1.ensureString(SourceTestkit.Env.getString('TESTKIT_JWT_CLIENT_ID'));
-            ts_types_1.ensureString(SourceTestkit.Env.getString('TESTKIT_HUB_INSTANCE'));
+            (0, ts_types_1.ensureString)(SourceTestkit.Env.getString('TESTKIT_JWT_KEY'));
+            (0, ts_types_1.ensureString)(SourceTestkit.Env.getString('TESTKIT_JWT_CLIENT_ID'));
+            (0, ts_types_1.ensureString)(SourceTestkit.Env.getString('TESTKIT_HUB_INSTANCE'));
         }
         SourceTestkit.Env.setString('TESTKIT_EXECUTABLE_PATH', this.executable);
         try {
@@ -406,7 +399,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
             this.executionLog = new executionLog_1.ExecutionLog(context);
             this.expect = new assertions_1.Assertions(context, this.executionLog, this.fileTracker);
             this.testMetadataFolder = path.join(__dirname, 'metadata');
-            this.testMetadataFiles = (await fileTracker_1.traverseForFiles(this.testMetadataFolder))
+            this.testMetadataFiles = (await (0, fileTracker_1.traverseForFiles)(this.testMetadataFolder))
                 .filter((f) => !f.endsWith('.DS_Store'))
                 .map((f) => f.replace(`${this.testMetadataFolder}${path.sep}`, ''));
         }
@@ -421,7 +414,7 @@ class SourceTestkit extends kit_1.AsyncCreatable {
                 .replace(SourceTestkit.LocalProdPath, '')
                 .replace(SourceTestkit.LocalDevPath, '');
             const pkgJsonPath = path.join(npmPackagePath, 'package.json');
-            const pkgJson = (await core_1.fs.readJsonMap(pkgJsonPath));
+            const pkgJson = (0, kit_1.parseJsonMap)(await fs.promises.readFile(pkgJsonPath, 'utf8'));
             return pkgJson.oclif.bin;
         }
         else {
@@ -468,10 +461,13 @@ class SourceTestkit extends kit_1.AsyncCreatable {
         });
     }
     async getDefaultUsername() {
-        const configVar = this.executableName === Executable.SF ? 'target-org' : core_1.Config.DEFAULT_USERNAME;
-        const configResult = cli_plugins_testkit_1.execCmd(`config:get ${configVar} --json`).jsonOutput;
-        const results = ts_types_1.get(configResult, 'result', configResult);
-        const username = results.find((r) => r.key === configVar || r.name === configVar).value;
+        var _a, _b;
+        const configVar = 'target-org';
+        const configResult = (_a = (0, cli_plugins_testkit_1.execCmd)(`config:get ${configVar} --json`).jsonOutput) === null || _a === void 0 ? void 0 : _a.result;
+        // depending on which version of config:get the user has available, there may be a name or key
+        // eventually, drop the `key` option and the deprecated SfdxPropertyKeys
+        const possibleKeys = [configVar, core_1.SfdxPropertyKeys.DEFAULT_USERNAME];
+        const username = (_b = configResult === null || configResult === void 0 ? void 0 : configResult.find((r) => (r.key && possibleKeys.includes(r.key)) || (r.name && possibleKeys.includes(r.name)))) === null || _b === void 0 ? void 0 : _b.value;
         return username;
     }
     async createConnection() {

package/lib/types.d.ts

@@ -1,11 +1,9 @@
 import { Connection } from '@salesforce/core';
 import { JsonCollection, JsonMap, Nullable } from '@salesforce/ts-types';
-export declare type SfdxResult<T = JsonMap> = Nullable<JsonMap & {
+export declare type Result<T = JsonCollection> = Nullable<JsonMap & {
     status: number;
     result: T;
 }>;
-export declare type SfResult<T = JsonCollection> = Nullable<T>;
-export declare type Result<T = JsonCollection> = SfdxResult<T> | SfResult<T>;
 export declare type Context = {
     projectDir: string;
     connection: Nullable<Connection>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/source-testkit",
   "description": "testkit for running NUTs for source related commands",
-  "version": "0.0.17",
+  "version": "1.0.1",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -30,26 +30,26 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/cli-plugins-testkit": "^1.2.0",
-    "@salesforce/core": "^2.20.11",
+    "@salesforce/cli-plugins-testkit": "^2.0.0",
+    "@salesforce/core": "^3.19.1",
     "@salesforce/kit": "^1.4.5",
-    "@salesforce/source-deploy-retrieve": "^4.0.2",
+    "@salesforce/source-deploy-retrieve": "^6.0.2",
     "@salesforce/ts-types": "^1.5.5",
     "archiver": "^5.2.0",
     "chai-each": "^0.0.1",
     "debug": "^4.3.1",
     "shelljs": "^0.8.4",
     "sinon": "^10.0.0",
-    "strip-ansi": "^6.0.0"
+    "strip-ansi": "^7.0.1"
   },
   "devDependencies": {
     "@salesforce/dev-config": "^3.0.0",
-    "@salesforce/dev-scripts": "^2.0.0",
+    "@salesforce/dev-scripts": "^2.0.2",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.5",
     "@types/archiver": "^5.1.0",
     "@types/debug": "^4.1.5",
-    "@types/shelljs": "^0.8.8",
+    "@types/shelljs": "^0.8.11",
     "@typescript-eslint/eslint-plugin": "^4.15.2",
     "@typescript-eslint/parser": "^4.15.2",
     "chai": "^4.3.0",
@@ -59,7 +59,7 @@
     "eslint-config-prettier": "^8.1.0",
     "eslint-config-salesforce": "^0.1.6",
     "eslint-config-salesforce-license": "^0.1.6",
-    "eslint-config-salesforce-typescript": "^0.2.7",
+    "eslint-config-salesforce-typescript": "^0.2.8",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jsdoc": "^32.2.0",
@@ -69,9 +69,9 @@
     "nyc": "^15.1.0",
     "prettier": "^2.0.5",
     "pretty-quick": "^3.1.0",
-    "sinon": "10.0.0",
+    "sinon": "^10.0.0",
     "ts-node": "^10.0.0",
-    "typescript": "^4.1.3"
+    "typescript": "^4.7.2"
   },
   "config": {
     "commitizen": {