@salesforce/core 3.7.6 → 3.7.7

package/lib/status/streamingClient.d.ts

@@ -1,6 +1,6 @@
 import { AsyncOptionalCreatable, Duration, Env } from '@salesforce/kit/lib';
 import { AnyJson } from '@salesforce/ts-types/lib';
-import { Org } from '../org';
+import { Org } from '../org/org';
 import { CometClient, CometSubscription, Message, StatusResult, StreamingExtension, StreamProcessor } from './types';
 export { CometClient, CometSubscription, Message, StatusResult, StreamingExtension, StreamProcessor };
 /**
@@ -113,7 +113,7 @@ export declare class StreamingClient extends AsyncOptionalCreatable<StreamingCli
      * Subscribe to streaming events. When the streaming processor that's set in the options completes execution it
      * returns a payload in the StatusResult object. The payload is just echoed here for convenience.
      *
-     * **Throws** *{@link SfdxError}{ name: '{@link StreamingClient.TimeoutErrorType.SUBSCRIBE}'}* When the subscribe timeout occurs.
+     * **Throws** *{@link SfError}{ name: '{@link StreamingClient.TimeoutErrorType.SUBSCRIBE}'}* When the subscribe timeout occurs.
      *
      * @param streamInit This function should call the platform apis that result in streaming updates on push topics.
      * {@link StatusResult}

package/lib/status/streamingClient.js

@@ -13,7 +13,7 @@ const lib_1 = require("@salesforce/kit/lib");
 const lib_2 = require("@salesforce/ts-types/lib");
 const Faye = require("faye");
 const logger_1 = require("../logger");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const messages_1 = require("../messages");
 const types_1 = require("./types");
 Object.defineProperty(exports, "CometClient", { enumerable: true, get: function () { return types_1.CometClient; } });
@@ -151,7 +151,7 @@ class StreamingClient extends lib_1.AsyncOptionalCreatable {
             this.cometClient.setHeader('Authorization', `OAuth ${accessToken}`);
         }
         else {
-            throw new sfdxError_1.SfdxError('Missing or invalid access token', 'MissingOrInvalidAccessToken');
+            throw new sfError_1.SfError('Missing or invalid access token', 'MissingOrInvalidAccessToken');
         }
         this.log(`Streaming client target url: ${this.targetUrl}`);
         this.log(`options.subscribeTimeout (ms): ${this.options.subscribeTimeout.milliseconds}`);
@@ -201,7 +201,7 @@ class StreamingClient extends lib_1.AsyncOptionalCreatable {
      * Subscribe to streaming events. When the streaming processor that's set in the options completes execution it
      * returns a payload in the StatusResult object. The payload is just echoed here for convenience.
      *
-     * **Throws** *{@link SfdxError}{ name: '{@link StreamingClient.TimeoutErrorType.SUBSCRIBE}'}* When the subscribe timeout occurs.
+     * **Throws** *{@link SfError}{ name: '{@link StreamingClient.TimeoutErrorType.SUBSCRIBE}'}* When the subscribe timeout occurs.
      *
      * @param streamInit This function should call the platform apis that result in streaming updates on push topics.
      * {@link StatusResult}
@@ -342,13 +342,13 @@ exports.StreamingClient = StreamingClient;
                 logger.warn('envDep is deprecated');
             }
             if (!streamProcessor) {
-                throw new sfdxError_1.SfdxError('Missing stream processor', 'MissingArg');
+                throw new sfError_1.SfError('Missing stream processor', 'MissingArg');
             }
             if (!org) {
-                throw new sfdxError_1.SfdxError('Missing org', 'MissingArg');
+                throw new sfError_1.SfError('Missing org', 'MissingArg');
             }
             if (!channel) {
-                throw new sfdxError_1.SfdxError('Missing streaming channel', 'MissingArg');
+                throw new sfError_1.SfError('Missing streaming channel', 'MissingArg');
             }
             this.org = org;
             this.apiVersion = org.getConnection().getApiVersion();

package/lib/testSetup.d.ts

@@ -4,7 +4,7 @@ import * as sinonType from 'sinon';
 import { AnyJson, JsonMap, Optional } from '@salesforce/ts-types';
 import { ConfigContents } from './config/configStore';
 import { Logger } from './logger';
-import { SfdxError } from './sfdxError';
+import { SfError } from './sfError';
 import { CometClient, CometSubscription, Message, StreamingExtension } from './status/streamingClient';
 import { SfOrg } from './globalInfo';
 /**
@@ -85,7 +85,7 @@ export interface TestContext {
         [configName: string]: Optional<ConfigStub>;
         GlobalInfo?: ConfigStub;
         Aliases?: ConfigStub;
-        SfdxProjectJson?: ConfigStub;
+        SfProjectJson?: ConfigStub;
         SfdxConfig?: ConfigStub;
     };
     /**
@@ -252,7 +252,7 @@ export declare const testSetup: (sinon?: any) => TestContext;
  *
  * **See** {@link shouldThrow}
  */
-export declare const unexpectedResult: SfdxError;
+export declare const unexpectedResult: SfError;
 /**
  * Use for this testing pattern:
  * ```
@@ -302,7 +302,7 @@ export interface StreamingMockCometSubscriptionOptions {
     /**
      * If it's an error that states what that error should be.
      */
-    subscriptionErrbackError?: SfdxError;
+    subscriptionErrbackError?: SfError;
     /**
      * A list of messages to playback for the client. One message per process tick.
      */

package/lib/testSetup.js

@@ -21,8 +21,8 @@ const connection_1 = require("./org/connection");
 const crypto_2 = require("./crypto/crypto");
 const logger_1 = require("./logger");
 const messages_1 = require("./messages");
-const sfdxError_1 = require("./sfdxError");
-const sfdxProject_1 = require("./sfdxProject");
+const sfError_1 = require("./sfError");
+const sfProject_1 = require("./sfProject");
 const streamingClient_1 = require("./status/streamingClient");
 const globalInfo_1 = require("./globalInfo");
 const global_1 = require("./global");
@@ -126,12 +126,12 @@ const instantiateContext = (sinon) => {
         inProject(inProject = true) {
             testContext.SANDBOXES.PROJECT.restore();
             if (inProject) {
-                testContext.SANDBOXES.PROJECT.stub(sfdxProject_1.SfdxProject, 'resolveProjectPath').callsFake(() => testContext.localPathRetriever(testContext.id));
-                testContext.SANDBOXES.PROJECT.stub(sfdxProject_1.SfdxProject, 'resolveProjectPathSync').callsFake(() => testContext.localPathRetrieverSync(testContext.id));
+                testContext.SANDBOXES.PROJECT.stub(sfProject_1.SfProject, 'resolveProjectPath').callsFake(() => testContext.localPathRetriever(testContext.id));
+                testContext.SANDBOXES.PROJECT.stub(sfProject_1.SfProject, 'resolveProjectPathSync').callsFake(() => testContext.localPathRetrieverSync(testContext.id));
             }
             else {
-                testContext.SANDBOXES.PROJECT.stub(sfdxProject_1.SfdxProject, 'resolveProjectPath').rejects(new sfdxError_1.SfdxError('', 'InvalidProjectWorkspaceError'));
-                testContext.SANDBOXES.PROJECT.stub(sfdxProject_1.SfdxProject, 'resolveProjectPathSync').throws(new sfdxError_1.SfdxError('', 'InvalidProjectWorkspaceError'));
+                testContext.SANDBOXES.PROJECT.stub(sfProject_1.SfProject, 'resolveProjectPath').rejects(new sfError_1.SfError('', 'InvalidProjectWorkspaceError'));
+                testContext.SANDBOXES.PROJECT.stub(sfProject_1.SfProject, 'resolveProjectPathSync').throws(new sfError_1.SfError('', 'InvalidProjectWorkspaceError'));
             }
         },
     };
@@ -174,7 +174,7 @@ const stubContext = (testContext) => {
     testContext.inProject(true);
     testContext.SANDBOXES.CONFIG.stub(configFile_1.ConfigFile, 'resolveRootFolder').callsFake((isGlobal) => testContext.rootPathRetriever(isGlobal, testContext.id));
     testContext.SANDBOXES.CONFIG.stub(configFile_1.ConfigFile, 'resolveRootFolderSync').callsFake((isGlobal) => testContext.rootPathRetrieverSync(isGlobal, testContext.id));
-    (0, ts_sinon_1.stubMethod)(testContext.SANDBOXES.PROJECT, sfdxProject_1.SfdxProjectJson.prototype, 'doesPackageExist').callsFake(() => true);
+    (0, ts_sinon_1.stubMethod)(testContext.SANDBOXES.PROJECT, sfProject_1.SfProjectJson.prototype, 'doesPackageExist').callsFake(() => true);
     const initStubForRead = (configFile) => {
         const stub = testContext.configStubs[configFile.constructor.name] || {};
         // init calls read calls getPath which sets the path on the config file the first time.
@@ -324,7 +324,7 @@ exports.testSetup = (0, kit_1.once)(_testSetup);
  *
  * **See** {@link shouldThrow}
  */
-exports.unexpectedResult = new sfdxError_1.SfdxError('This code was expected to fail', 'UnexpectedResult');
+exports.unexpectedResult = new sfError_1.SfError('This code was expected to fail', 'UnexpectedResult');
 /**
  * Use for this testing pattern:
  * ```

package/lib/util/fs.js

@@ -13,7 +13,7 @@ const util_1 = require("util");
 const kit_1 = require("@salesforce/kit");
 const fsLib = require("graceful-fs");
 const mkdirpLib = require("mkdirp");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 /**
  * @deprecated Use fs/promises instead
  */
@@ -79,13 +79,13 @@ exports.fs = Object.assign({}, fsLib, {
      */
     remove: async (dirPath) => {
         if (!dirPath) {
-            throw new sfdxError_1.SfdxError('Path is null or undefined.', 'PathIsNullOrUndefined');
+            throw new sfError_1.SfError('Path is null or undefined.', 'PathIsNullOrUndefined');
         }
         try {
             await exports.fs.access(dirPath, fsLib.constants.R_OK);
         }
         catch (err) {
-            throw new sfdxError_1.SfdxError(`The path: ${dirPath} doesn't exist or access is denied.`, 'DirMissingOrNoAccess');
+            throw new sfError_1.SfError(`The path: ${dirPath} doesn't exist or access is denied.`, 'DirMissingOrNoAccess');
         }
         const files = await exports.fs.readdir(dirPath);
         const stats = await Promise.all(files.map((file) => exports.fs.stat(path.join(dirPath, file))));
@@ -105,13 +105,13 @@ exports.fs = Object.assign({}, fsLib, {
      */
     removeSync: (dirPath) => {
         if (!dirPath) {
-            throw new sfdxError_1.SfdxError('Path is null or undefined.', 'PathIsNullOrUndefined');
+            throw new sfError_1.SfError('Path is null or undefined.', 'PathIsNullOrUndefined');
         }
         try {
             exports.fs.accessSync(dirPath, fsLib.constants.R_OK);
         }
         catch (err) {
-            throw new sfdxError_1.SfdxError(`The path: ${dirPath} doesn't exist or access is denied.`, 'DirMissingOrNoAccess');
+            throw new sfError_1.SfError(`The path: ${dirPath} doesn't exist or access is denied.`, 'DirMissingOrNoAccess');
         }
         exports.fs.actOnSync(dirPath, (fullPath, file) => {
             if (file) {
@@ -340,7 +340,7 @@ exports.fs = Object.assign({}, fsLib, {
             return exports.fs.getContentHash(contentA) === exports.fs.getContentHash(contentB);
         }
         catch (err) {
-            throw new sfdxError_1.SfdxError(`The path: ${err.path} doesn't exist or access is denied.`, 'DirMissingOrNoAccess');
+            throw new sfError_1.SfError(`The path: ${err.path} doesn't exist or access is denied.`, 'DirMissingOrNoAccess');
         }
     },
     /**
@@ -362,7 +362,7 @@ exports.fs = Object.assign({}, fsLib, {
             return exports.fs.getContentHash(contentA) === exports.fs.getContentHash(contentB);
         }
         catch (err) {
-            throw new sfdxError_1.SfdxError(`The path: ${err.path} doesn't exist or access is denied.`, 'DirMissingOrNoAccess');
+            throw new sfError_1.SfError(`The path: ${err.path} doesn't exist or access is denied.`, 'DirMissingOrNoAccess');
         }
     },
     /**

package/lib/util/internal.d.ts

@@ -11,7 +11,7 @@ export declare const SFDX_PROJECT_JSON = "sfdx-project.json";
  *
  * **See** {@link traverseForFile}
  *
- * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+ * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
  *
  * @param dir The directory path to start traversing from.
  * @ignore
@@ -24,7 +24,7 @@ export declare function resolveProjectPath(dir?: string): Promise<string>;
  *
  * **See** {@link traverseForFile}
  *
- * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+ * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
  *
  * @param dir The directory path to start traversing from.
  * @ignore

package/lib/util/internal.js

@@ -25,7 +25,7 @@ exports.SFDX_PROJECT_JSON = 'sfdx-project.json';
  *
  * **See** {@link traverseForFile}
  *
- * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+ * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
  *
  * @param dir The directory path to start traversing from.
  * @ignore
@@ -45,7 +45,7 @@ exports.resolveProjectPath = resolveProjectPath;
  *
  * **See** {@link traverseForFile}
  *
- * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+ * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
  *
  * @param dir The directory path to start traversing from.
  * @ignore

package/lib/util/sfdcUrl.d.ts

@@ -43,7 +43,7 @@ export declare class SfdcUrl extends URL {
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns {Promise<true | never>} The resolved ip address or never
-     * @throws {@link SfdxError} If can't resolve DNS.
+     * @throws {@link SfError} If can't resolve DNS.
      */
     checkLightningDomain(): Promise<true | never>;
     /**
@@ -51,7 +51,7 @@ export declare class SfdcUrl extends URL {
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns the resolved ip address.
-     * @throws {@link SfdxError} If can't resolve DNS.
+     * @throws {@link SfError} If can't resolve DNS.
      */
     lookup(): Promise<string>;
     /**

package/lib/util/sfdcUrl.js

@@ -121,7 +121,7 @@ class SfdcUrl extends url_1.URL {
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns {Promise<true | never>} The resolved ip address or never
-     * @throws {@link SfdxError} If can't resolve DNS.
+     * @throws {@link SfError} If can't resolve DNS.
      */
     async checkLightningDomain() {
         const quantity = (0, ts_types_1.ensureNumber)(new kit_1.Env().getNumber('SFDX_DOMAIN_RETRY', 240));
@@ -142,7 +142,7 @@ class SfdcUrl extends url_1.URL {
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns the resolved ip address.
-     * @throws {@link SfdxError} If can't resolve DNS.
+     * @throws {@link SfError} If can't resolve DNS.
      */
     async lookup() {
         const quantity = (0, ts_types_1.ensureNumber)(new kit_1.Env().getNumber('SFDX_DOMAIN_RETRY', 240));

package/lib/webOAuthServer.js

@@ -16,9 +16,9 @@ const ts_types_1 = require("@salesforce/ts-types");
 const jsforce_1 = require("jsforce");
 const logger_1 = require("./logger");
 const authInfo_1 = require("./org/authInfo");
-const sfdxError_1 = require("./sfdxError");
+const sfError_1 = require("./sfError");
 const messages_1 = require("./messages");
-const sfdxProject_1 = require("./sfdxProject");
+const sfProject_1 = require("./sfProject");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'auth', [
     'invalidRequestUri',
@@ -56,8 +56,8 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
      */
     static async determineOauthPort() {
         try {
-            const sfdxProject = await sfdxProject_1.SfdxProjectJson.create();
-            return sfdxProject.get('oauthLocalPort') || WebOAuthServer.DEFAULT_PORT;
+            const sfProject = await sfProject_1.SfProjectJson.create();
+            return sfProject.get('oauthLocalPort') || WebOAuthServer.DEFAULT_PORT;
         }
         catch {
             return WebOAuthServer.DEFAULT_PORT;
@@ -152,7 +152,7 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
                     if (url.pathname && url.pathname.startsWith('/OauthRedirect')) {
                         request.query = (0, querystring_1.parse)(url.query);
                         if (request.query.error) {
-                            const err = new sfdxError_1.SfdxError(request.query.error_description || request.query.error, request.query.error);
+                            const err = new sfError_1.SfError(request.query.error_description || request.query.error, request.query.error);
                             this.webServer.reportError(err, response);
                             return reject(err);
                         }
@@ -169,14 +169,14 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
                         this.webServer.sendError(404, 'Resource not found', response);
                         const errName = 'invalidRequestUri';
                         const errMessage = messages.getMessage(errName, [url.pathname]);
-                        reject(new sfdxError_1.SfdxError(errMessage, errName));
+                        reject(new sfError_1.SfError(errMessage, errName));
                     }
                 }
                 else {
                     this.webServer.sendError(405, 'Unsupported http methods', response);
                     const errName = 'invalidRequestMethod';
                     const errMessage = messages.getMessage(errName, [request.method]);
-                    reject(new sfdxError_1.SfdxError(errMessage, errName));
+                    reject(new sfError_1.SfError(errMessage, errName));
                 }
             });
         });
@@ -190,7 +190,7 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
      */
     parseAuthCodeFromRequest(response, request) {
         if (!this.validateState(request)) {
-            const error = new sfdxError_1.SfdxError('urlStateMismatch');
+            const error = new sfError_1.SfError('urlStateMismatch');
             this.webServer.sendError(400, `${error.message}\n`, response);
             this.closeRequest(request);
             this.logger.warn('urlStateMismatchAttempt detected.');
@@ -343,13 +343,13 @@ class WebServer extends kit_1.AsyncCreatable {
             const socket = new net_1.Socket();
             socket.setTimeout(this.getSocketTimeout(), () => {
                 socket.destroy();
-                const error = new sfdxError_1.SfdxError('timeout', 'SOCKET_TIMEOUT');
+                const error = new sfError_1.SfError('timeout', 'SOCKET_TIMEOUT');
                 reject(error);
             });
             // An existing connection, means that the port is occupied
             socket.connect(clientConfig, () => {
                 socket.destroy();
-                const error = new sfdxError_1.SfdxError('Address in use', 'EADDRINUSE');
+                const error = new sfError_1.SfError('Address in use', 'EADDRINUSE');
                 error.data = {
                     port: clientConfig.port,
                     address: clientConfig.host,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.7.6",
+  "version": "3.7.7",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",