@salesforce/core 3.7.7 → 3.8.0

package/lib/org/authInfo.js

@@ -10,6 +10,7 @@ exports.AuthInfo = exports.DEFAULT_CONNECTED_APP_INFO = void 0;
 const crypto_1 = require("crypto");
 const path_1 = require("path");
 const os = require("os");
+const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const jsforce_1 = require("jsforce");
@@ -19,7 +20,6 @@ const config_1 = require("../config/config");
 const configAggregator_1 = require("../config/configAggregator");
 const logger_1 = require("../logger");
 const sfError_1 = require("../sfError");
-const fs_1 = require("../util/fs");
 const sfdc_1 = require("../util/sfdc");
 const globalInfo_1 = require("../globalInfo");
 const messages_1 = require("../messages");
@@ -398,6 +398,22 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         sfdxAuthUrl += `${(0, ts_types_1.ensure)(decryptedFields.refreshToken, 'undefined refreshToken')}@${instanceUrl}`;
         return sfdxAuthUrl;
     }
+    /**
+     * Convenience function to handle typical side effects encountered when dealing with an AuthInfo.
+     * Given the values supplied in parameter sideEffects, this functions will set auth alias, default auth
+     * and default dev hub.
+     *
+     * @param sideEffects - instance of AuthSideEffects
+     */
+    async handleAliasAndDefaultSettings(sideEffects) {
+        if (sideEffects.alias)
+            await this.setAlias(sideEffects.alias);
+        if (sideEffects.setDefault)
+            await this.setAsDefault({ org: true });
+        if (sideEffects.setDefaultDevHub)
+            await this.setAsDefault({ devHub: true });
+        await this.save();
+    }
     /**
      * Set the target-env (default) or the target-dev-hub to the alias if
      * it exists otherwise to the username. Method will try to set the local
@@ -584,7 +600,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     }
     // Build OAuth config for a JWT auth flow
     async buildJwtConfig(options) {
-        const privateKeyContents = await fs_1.fs.readFile((0, ts_types_1.ensure)(options.privateKey), 'utf8');
+        const privateKeyContents = await fs.promises.readFile((0, ts_types_1.ensure)(options.privateKey), 'utf8');
         const { loginUrl = sfdcUrl_1.SfdcUrl.PRODUCTION } = options;
         const url = new sfdcUrl_1.SfdcUrl(loginUrl);
         const createdOrgInstance = (0, ts_types_1.getString)(options, 'createdOrgInstance', '').trim().toLowerCase();

package/lib/org/org.js

@@ -8,6 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Org = exports.SandboxEvents = exports.OrgTypes = void 0;
 const path_1 = require("path");
+const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const config_1 = require("../config/config");
@@ -18,7 +19,6 @@ const global_1 = require("../global");
 const lifecycleEvents_1 = require("../lifecycleEvents");
 const logger_1 = require("../logger");
 const sfError_1 = require("../sfError");
-const fs_1 = require("../util/fs");
 const sfdc_1 = require("../util/sfdc");
 const webOAuthServer_1 = require("../webOAuthServer");
 const messages_1 = require("../messages");
@@ -147,7 +147,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
             }
             throw err;
         }
-        return this.manageDelete(async () => await fs_1.fs.remove(dataPath), dataPath, throwWhenRemoveFails);
+        return this.manageDelete(async () => await fs.promises.rmdir(dataPath), dataPath, throwWhenRemoveFails);
     }
     /**
      * @ignore
@@ -850,7 +850,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
             catch (err) {
                 const error = err;
                 this.logger.debug('Exception while calling writeSandboxAuthFile %s', err);
-                if ((error === null || error === void 0 ? void 0 : error.name) === 'JWTAuthError' && ((_a = error === null || error === void 0 ? void 0 : error.stack) === null || _a === void 0 ? void 0 : _a.includes("user hasn't approved"))) {
+                if ((error === null || error === void 0 ? void 0 : error.name) === 'JwtAuthError' && ((_a = error === null || error === void 0 ? void 0 : error.stack) === null || _a === void 0 ? void 0 : _a.includes("user hasn't approved"))) {
                     waitingOnAuth = true;
                 }
                 else {

package/lib/schema/validator.js

@@ -8,11 +8,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaValidator = void 0;
 const path = require("path");
+const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const validator = require("jsen");
 const sfError_1 = require("../sfError");
-const fs_1 = require("../util/fs");
 /**
  * Loads a JSON schema and performs validations against JSON objects.
  */
@@ -33,7 +33,7 @@ class SchemaValidator {
      */
     async load() {
         if (!this.schema) {
-            this.schema = await fs_1.fs.readJsonMap(this.schemaPath);
+            this.schema = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.schemaPath, 'utf8'));
             this.logger.debug(`Schema loaded for ${this.schemaPath}`);
         }
         return this.schema;
@@ -43,7 +43,7 @@ class SchemaValidator {
      */
     loadSync() {
         if (!this.schema) {
-            this.schema = fs_1.fs.readJsonMapSync(this.schemaPath);
+            this.schema = (0, kit_1.parseJsonMap)(fs.readFileSync(this.schemaPath, 'utf8'));
             this.logger.debug(`Schema loaded for ${this.schemaPath}`);
         }
         return this.schema;
@@ -125,7 +125,7 @@ class SchemaValidator {
     loadExternalSchema(uri) {
         const schemaPath = path.join(this.schemasDir, `${uri}.json`);
         try {
-            return fs_1.fs.readJsonMapSync(schemaPath);
+            return (0, kit_1.parseJsonMap)(fs.readFileSync(schemaPath, 'utf8'));
         }
         catch (err) {
             if (err.code === 'ENOENT') {

package/lib/sfError.d.ts

@@ -68,11 +68,6 @@ export declare class SfError extends NamedError {
      * Convert an {@link SfError} state to an object. Returns a plain object representing the state of this error.
      */
     toObject(): JsonMap;
-    /**
-     * @deprecated Does nothing. Do not use. This is kept around to support older versions of SfdxCommand.
-     * @param commandName
-     */
-    setCommandName(): void;
 }
 /**
  * @deprecated use SfError instead

package/lib/sfError.js

@@ -109,13 +109,6 @@ class SfError extends kit_1.NamedError {
         }
         return obj;
     }
-    /**
-     * @deprecated Does nothing. Do not use. This is kept around to support older versions of SfdxCommand.
-     * @param commandName
-     */
-    setCommandName() {
-        /** Do nothing. */
-    }
 }
 exports.SfError = SfError;
 /**

package/lib/sfProject.js

@@ -8,13 +8,13 @@ exports.SfdxProjectJson = exports.SfdxProject = exports.SfProject = exports.SfPr
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 const path_1 = require("path");
+const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const sfdcUrl_1 = require("./util/sfdcUrl");
 const configAggregator_1 = require("./config/configAggregator");
 const configFile_1 = require("./config/configFile");
 const validator_1 = require("./schema/validator");
-const fs_1 = require("./util/fs");
 const internal_1 = require("./util/internal");
 const sfError_1 = require("./sfError");
 const sfdc_1 = require("./util/sfdc");
@@ -248,7 +248,7 @@ class SfProjectJson extends configFile_1.ConfigFile {
         return this.getContents().packageDirectories && this.getContents().packageDirectories.length > 1;
     }
     doesPackageExist(packagePath) {
-        return fs_1.fs.existsSync(packagePath);
+        return fs.existsSync(packagePath);
     }
     validateKeys() {
         // Verify that the configObject does not have upper case keys; throw if it does.  Must be heads down camel case.

package/lib/util/internal.d.ts

@@ -1,3 +1,4 @@
+import { Optional } from '@salesforce/ts-types';
 /**
  * The name of the project config file.
  *
@@ -30,3 +31,28 @@ export declare function resolveProjectPath(dir?: string): Promise<string>;
  * @ignore
  */
 export declare function resolveProjectPathSync(dir?: string): string;
+/**
+ * These methods were moved from the deprecated 'fs' module in v2 and are only used in sfdx-core above
+ *
+ * They were migrated into the 'traverse' constant in order to stub them in unit tests
+ */
+export declare const traverse: {
+    /**
+     * Searches a file path in an ascending manner (until reaching the filesystem root) for the first occurrence a
+     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
+     * not found.
+     *
+     * @param dir The directory path in which to start the upward search.
+     * @param file The file name to look for.
+     */
+    forFile: (dir: string, file: string) => Promise<Optional<string>>;
+    /**
+     * Searches a file path synchronously in an ascending manner (until reaching the filesystem root) for the first occurrence a
+     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
+     * not found.
+     *
+     * @param dir The directory path in which to start the upward search.
+     * @param file The file name to look for.
+     */
+    forFileSync: (dir: string, file: string) => Optional<string>;
+};

package/lib/util/internal.js

@@ -6,9 +6,10 @@
  * 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.resolveProjectPathSync = exports.resolveProjectPath = exports.SFDX_PROJECT_JSON = void 0;
+exports.traverse = exports.resolveProjectPathSync = exports.resolveProjectPath = exports.SFDX_PROJECT_JSON = void 0;
+const fs = require("fs");
+const path_1 = require("path");
 const messages_1 = require("../messages");
-const fs_1 = require("./fs");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'config', ['invalidProjectWorkspace']);
 /**
@@ -31,7 +32,7 @@ exports.SFDX_PROJECT_JSON = 'sfdx-project.json';
  * @ignore
  */
 async function resolveProjectPath(dir = process.cwd()) {
-    const projectPath = await fs_1.fs.traverseForFile(dir, exports.SFDX_PROJECT_JSON);
+    const projectPath = await exports.traverse.forFile(dir, exports.SFDX_PROJECT_JSON);
     if (!projectPath) {
         throw messages.createError('invalidProjectWorkspace');
     }
@@ -51,11 +52,68 @@ exports.resolveProjectPath = resolveProjectPath;
  * @ignore
  */
 function resolveProjectPathSync(dir = process.cwd()) {
-    const projectPath = fs_1.fs.traverseForFileSync(dir, exports.SFDX_PROJECT_JSON);
+    const projectPath = exports.traverse.forFileSync(dir, exports.SFDX_PROJECT_JSON);
     if (!projectPath) {
         throw messages.createError('invalidProjectWorkspace');
     }
     return projectPath;
 }
 exports.resolveProjectPathSync = resolveProjectPathSync;
+/**
+ * These methods were moved from the deprecated 'fs' module in v2 and are only used in sfdx-core above
+ *
+ * They were migrated into the 'traverse' constant in order to stub them in unit tests
+ */
+exports.traverse = {
+    /**
+     * Searches a file path in an ascending manner (until reaching the filesystem root) for the first occurrence a
+     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
+     * not found.
+     *
+     * @param dir The directory path in which to start the upward search.
+     * @param file The file name to look for.
+     */
+    forFile: async (dir, file) => {
+        let foundProjectDir;
+        try {
+            fs.statSync((0, path_1.join)(dir, file));
+            foundProjectDir = dir;
+        }
+        catch (err) {
+            if (err && err.code === 'ENOENT') {
+                const nextDir = (0, path_1.resolve)(dir, '..');
+                if (nextDir !== dir) {
+                    // stop at root
+                    foundProjectDir = await exports.traverse.forFile(nextDir, file);
+                }
+            }
+        }
+        return foundProjectDir;
+    },
+    /**
+     * Searches a file path synchronously in an ascending manner (until reaching the filesystem root) for the first occurrence a
+     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
+     * not found.
+     *
+     * @param dir The directory path in which to start the upward search.
+     * @param file The file name to look for.
+     */
+    forFileSync: (dir, file) => {
+        let foundProjectDir;
+        try {
+            fs.statSync((0, path_1.join)(dir, file));
+            foundProjectDir = dir;
+        }
+        catch (err) {
+            if (err && err.code === 'ENOENT') {
+                const nextDir = (0, path_1.resolve)(dir, '..');
+                if (nextDir !== dir) {
+                    // stop at root
+                    foundProjectDir = exports.traverse.forFileSync(nextDir, file);
+                }
+            }
+        }
+        return foundProjectDir;
+    },
+};
 //# sourceMappingURL=internal.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.7.7",
+  "version": "3.8.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -34,9 +34,9 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@oclif/core": "^1.3.1",
+    "@oclif/core": "^1.5.1",
     "@salesforce/bunyan": "^2.0.0",
-    "@salesforce/kit": "^1.5.28",
+    "@salesforce/kit": "^1.5.34",
     "@salesforce/schemas": "^1.1.0",
     "@salesforce/ts-types": "^1.5.20",
     "@types/graceful-fs": "^4.1.5",
@@ -56,8 +56,8 @@
     "ts-retry-promise": "^0.6.0"
   },
   "devDependencies": {
-    "@salesforce/dev-config": "^3.0.0",
-    "@salesforce/dev-scripts": "^2.0.0",
+    "@salesforce/dev-config": "^3.0.1",
+    "@salesforce/dev-scripts": "^2.0.1",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.21",
     "@types/archiver": "^5.3.1",

package/lib/util/fs.d.ts

@@ -1,201 +0,0 @@
-/// <reference types="node" />
-import { AnyJson, JsonMap, Optional } from '@salesforce/ts-types';
-import * as fsLib from 'graceful-fs';
-import * as mkdirpLib from 'mkdirp';
-declare type PerformFunction = (filePath: string, file?: string, dir?: string) => Promise<void>;
-declare type PerformFunctionSync = (filePath: string, file?: string, dir?: string) => void;
-export declare type WriteJsonOptions = {
-    /**
-     * The number of indent spaces
-     */
-    space?: number;
-};
-/**
- * @deprecated Use fs/promises instead
- */
-export declare const fs: typeof fsLib & {
-    /**
-     * The default file system mode to use when creating directories.
-     */
-    DEFAULT_USER_DIR_MODE: string;
-    /**
-     * The default file system mode to use when creating files.
-     */
-    DEFAULT_USER_FILE_MODE: string;
-    /**
-     * A convenience reference to {@link https://nodejs.org/api/fsLib.html#fs_fs_constants}
-     * to reduce the need to import multiple `fs` modules.
-     */
-    constants: typeof fsLib.constants;
-    /**
-     * Promisified version of {@link https://nodejs.org/api/fsLib.html#fs_fs_readfile_path_options_callback|fsLib.readFile}.
-     */
-    readFile: typeof fsLib.readFile.__promisify__;
-    /**
-     * Promisified version of {@link https://nodejs.org/api/fsLib.html#fs_fs_readdir_path_options_callback|fsLib.readdir}.
-     */
-    readdir: typeof fsLib.readdir.__promisify__;
-    /**
-     * Promisified version of {@link https://nodejs.org/api/fsLib.html#fs_fs_writefile_file_data_options_callback|fsLib.writeFile}.
-     */
-    writeFile: typeof fsLib.writeFile.__promisify__;
-    /**
-     * Promisified version of {@link https://nodejs.org/api/fsLib.html#fs_fs_access_path_mode_callback|fsLib.access}.
-     */
-    access: typeof fsLib.access.__promisify__;
-    /**
-     * Promisified version of {@link https://nodejs.org/api/fsLib.html#fs_fs_open_path_flags_mode_callback|fsLib.open}.
-     */
-    open: typeof fsLib.open.__promisify__;
-    /**
-     * Promisified version of {@link https://nodejs.org/api/fsLib.html#fs_fs_unlink_path_callback|fsLib.unlink}.
-     */
-    unlink: typeof fsLib.unlink.__promisify__;
-    /**
-     * Promisified version of {@link https://nodejs.org/api/fsLib.html#fs_fs_readdir_path_options_callback|fsLib.rmdir}.
-     */
-    rmdir: typeof fsLib.rmdir.__promisify__;
-    /**
-     * Promisified version of {@link https://nodejs.org/api/fsLib.html#fs_fs_fstat_fd_callback|fsLib.stat}.
-     */
-    stat: typeof fsLib.stat.__promisify__;
-    /**
-     * Promisified version of {@link https://npmjs.com/package/mkdirp|mkdirp}.
-     */
-    mkdirp: (folderPath: string, mode?: string | object | undefined) => Promise<string | undefined>;
-    mkdirpSync: typeof mkdirpLib.sync;
-    /**
-     * Deletes a folder recursively, removing all descending files and folders.
-     *
-     * **Throws** *PathIsNullOrUndefined* The path is not defined.
-     * **Throws** *DirMissingOrNoAccess* The folder or any sub-folder is missing or has no access.
-     *
-     * @param {string} dirPath The path to remove.
-     */
-    remove: (dirPath: string) => Promise<void>;
-    /**
-     * Deletes a folder recursively, removing all descending files and folders.
-     *
-     * NOTE: It is recommended to call the asynchronous `remove` when possible as it will remove all files in parallel rather than serially.
-     *
-     * **Throws** *PathIsNullOrUndefined* The path is not defined.
-     * **Throws** *DirMissingOrNoAccess* The folder or any sub-folder is missing or has no access.
-     *
-     * @param {string} dirPath The path to remove.
-     */
-    removeSync: (dirPath: string) => void;
-    /**
-     * Searches a file path in an ascending manner (until reaching the filesystem root) for the first occurrence a
-     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
-     * not found.
-     *
-     * @param dir The directory path in which to start the upward search.
-     * @param file The file name to look for.
-     */
-    traverseForFile: (dir: string, file: string) => Promise<Optional<string>>;
-    /**
-     * Searches a file path synchronously in an ascending manner (until reaching the filesystem root) for the first occurrence a
-     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
-     * not found.
-     *
-     * @param dir The directory path in which to start the upward search.
-     * @param file The file name to look for.
-     */
-    traverseForFileSync: (dir: string, file: string) => Optional<string>;
-    /**
-     * Read a file and convert it to JSON. Returns the contents of the file as a JSON object
-     *
-     * @param jsonPath The path of the file.
-     * @param throwOnEmpty Whether to throw an error if the JSON file is empty.
-     */
-    readJson: (jsonPath: string, throwOnEmpty?: boolean | undefined) => Promise<AnyJson>;
-    /**
-     * Read a file and convert it to JSON. Returns the contents of the file as a JSON object
-     *
-     * @param jsonPath The path of the file.
-     * @param throwOnEmpty Whether to throw an error if the JSON file is empty.
-     */
-    readJsonSync: (jsonPath: string, throwOnEmpty?: boolean | undefined) => AnyJson;
-    /**
-     * Read a file and convert it to JSON, throwing an error if the parsed contents are not a `JsonMap`.
-     *
-     * @param jsonPath The path of the file.
-     * @param throwOnEmpty Whether to throw an error if the JSON file is empty.
-     */
-    readJsonMap: <T extends JsonMap = JsonMap>(jsonPath: string, throwOnEmpty?: boolean | undefined) => Promise<T>;
-    /**
-     * Read a file and convert it to JSON, throwing an error if the parsed contents are not a `JsonMap`.
-     *
-     * @param jsonPath The path of the file.
-     * @param throwOnEmpty Whether to throw an error if the JSON file is empty.
-     */
-    readJsonMapSync: <T_1 extends JsonMap = JsonMap>(jsonPath: string, throwOnEmpty?: boolean | undefined) => T_1;
-    /**
-     * Convert a JSON-compatible object to a `string` and write it to a file.
-     *
-     * @param jsonPath The path of the file to write.
-     * @param data The JSON object to write.
-     */
-    writeJson: (jsonPath: string, data: AnyJson, options?: WriteJsonOptions) => Promise<void>;
-    /**
-     * Convert a JSON-compatible object to a `string` and write it to a file.
-     *
-     * @param jsonPath The path of the file to write.
-     * @param data The JSON object to write.
-     */
-    writeJsonSync: (jsonPath: string, data: AnyJson, options?: WriteJsonOptions) => void;
-    /**
-     * Checks if a file path exists
-     *
-     * @param filePath the file path to check the existence of
-     */
-    fileExists: (filePath: string) => Promise<boolean>;
-    /**
-     * Checks if a file path exists
-     *
-     * @param filePath the file path to check the existence of
-     */
-    fileExistsSync: (filePath: string) => boolean;
-    /**
-     * Recursively act on all files or directories in a directory
-     *
-     * @param dir path to directory
-     * @param perform function to be run on contents of dir
-     * @param onType optional parameter to specify type to actOn
-     * @returns void
-     */
-    actOn: (dir: string, perform: PerformFunction, onType?: 'file' | 'dir' | 'all') => Promise<void>;
-    /**
-     * Recursively act on all files or directories in a directory
-     *
-     * @param dir path to directory
-     * @param perform function to be run on contents of dir
-     * @param onType optional parameter to specify type to actOn
-     * @returns void
-     */
-    actOnSync: (dir: string, perform: PerformFunctionSync, onType?: 'file' | 'dir' | 'all') => void;
-    /**
-     * Checks if files are the same
-     *
-     * @param file1Path the first file path to check
-     * @param file2Path the second file path to check
-     * @returns boolean
-     */
-    areFilesEqual: (file1Path: string, file2Path: string) => Promise<boolean>;
-    /**
-     * Checks if files are the same
-     *
-     * @param file1Path the first file path to check
-     * @param file2Path the second file path to check
-     * @returns boolean
-     */
-    areFilesEqualSync: (file1Path: string, file2Path: string) => boolean;
-    /**
-     * Creates a hash for the string that's passed in
-     *
-     * @param contents The string passed into the function
-     * @returns string
-     */
-    getContentHash(contents: string | Buffer): string;
-};
-export {};