@salesforce/core 4.0.0-v3.0 → 4.0.0

package/lib/webOAuthServer.js

@@ -13,6 +13,7 @@ const url_1 = require("url");
 const net_1 = require("net");
 const kit_1 = require("@salesforce/kit");
 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");
@@ -58,7 +59,7 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
             const sfdxProject = await sfdxProject_1.SfdxProjectJson.create();
             return sfdxProject.get('oauthLocalPort') || WebOAuthServer.DEFAULT_PORT;
         }
-        catch (_a) {
+        catch {
             return WebOAuthServer.DEFAULT_PORT;
         }
     }
@@ -132,7 +133,7 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
         if (!this.oauthConfig.redirectUri)
             this.oauthConfig.redirectUri = `http://localhost:${port}/OauthRedirect`;
         this.webServer = await WebServer.create({ port });
-        this.oauth2 = new authInfo_1.OAuth2WithVerifier(this.oauthConfig);
+        this.oauth2 = new jsforce_1.OAuth2(this.oauthConfig);
         this.authUrl = authInfo_1.AuthInfo.getAuthorizationUrl(this.oauthConfig, this.oauth2);
     }
     /**
@@ -143,13 +144,13 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
     async executeOauthRequest() {
         return new Promise((resolve, reject) => {
             this.logger.debug('Starting web auth flow');
-            // eslint-disable-next-line @typescript-eslint/no-misused-promises
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises, @typescript-eslint/no-explicit-any
             this.webServer.server.on('request', async (request, response) => {
-                const url = url_1.parse(request.url);
+                const url = (0, url_1.parse)(request.url);
                 this.logger.debug(`processing request for uri: ${url.pathname}`);
                 if (request.method === 'GET') {
                     if (url.pathname && url.pathname.startsWith('/OauthRedirect')) {
-                        request.query = querystring_1.parse(url.query);
+                        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);
                             this.webServer.reportError(err, response);
@@ -157,7 +158,7 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
                         }
                         this.logger.debug(`request.query.state: ${request.query.state}`);
                         try {
-                            this.oauthConfig.authCode = ts_types_1.asString(this.parseAuthCodeFromRequest(response, request));
+                            this.oauthConfig.authCode = (0, ts_types_1.asString)(this.parseAuthCodeFromRequest(response, request));
                             resolve(response);
                         }
                         catch (err) {
@@ -193,9 +194,9 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
             this.webServer.sendError(400, `${error.message}\n`, response);
             this.closeRequest(request);
             this.logger.warn('urlStateMismatchAttempt detected.');
-            if (!ts_types_1.get(this.webServer.server, 'urlStateMismatchAttempt')) {
+            if (!(0, ts_types_1.get)(this.webServer.server, 'urlStateMismatchAttempt')) {
                 this.logger.error(error.message);
-                kit_1.set(this.webServer.server, 'urlStateMismatchAttempt', true);
+                (0, kit_1.set)(this.webServer.server, 'urlStateMismatchAttempt', true);
             }
         }
         else {
@@ -232,7 +233,7 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
      */
     validateState(request) {
         const state = request.query.state;
-        const query = url_1.parse(this.authUrl, true).query;
+        const query = (0, url_1.parse)(this.authUrl, true).query;
         return !!(state && state === query.state);
     }
 }
@@ -371,7 +372,7 @@ class WebServer extends kit_1.AsyncCreatable {
      */
     getSocketTimeout() {
         const env = new kit_1.Env();
-        const socketTimeout = kit_1.toNumber(env.getNumber('SFDX_HTTP_SOCKET_TIMEOUT'));
+        const socketTimeout = (0, kit_1.toNumber)(env.getNumber('SFDX_HTTP_SOCKET_TIMEOUT'));
         return Number.isInteger(socketTimeout) && socketTimeout > 0
             ? socketTimeout
             : WebServer.DEFAULT_CLIENT_SOCKET_TIMEOUT;

package/messages/auth.md

@@ -1,8 +1,8 @@
-# defaultUsernameNotSet
+# targetOrgNotSet
 
 A default user is not set.
 
-# defaultUsernameNotSet.actions
+# targetOrgNotSet.actions
 
 - Run the "sfdx auth" commands with --setdefaultusername to connect to an org and set it as your default org.
 - Run "force:org:create" with --setdefaultusername to create a scratch org and set it as your default org.

package/messages/config.md

@@ -1,10 +1,18 @@
 # unknownConfigKey
 
-Unknown config name: %s
+Unknown config name: %s.
+
+# deprecatedConfigKey
+
+Deprecated config name: %s. Please use %s instead.
+
+# invalidWrite
+
+The writeSync method is not allowed on SfdxConfig. Use the async write method instead.
 
 # invalidConfigValue
 
-Invalid config value: %s
+Invalid config value: %s.
 
 # invalidInstanceUrl
 
@@ -14,6 +22,10 @@ Specify a valid Salesforce instance URL.
 
 Specify a valid Salesforce API version, for example, 42.0.
 
+# invalidCustomOrgMetadataTemplates
+
+Specify a valid repository URL or directory for the custom org metadata templates.
+
 # invalidIsvDebuggerSid
 
 Specify a valid Debugger SID.
@@ -59,10 +71,50 @@ The path "%s", specified in sfdx-project.json, must be indicated as a relative p
 
 In sfdx-project.json, indicate only one package directory (path) as the default.
 
-# invalidWrite
-
-The writeSync method is not allowed on SfdxConfig. Use the async write method instead.
-
 # singleNonDefaultPackage
 
 The sfdx-project.json file must include one, and only one, default package directory (path). Because your sfdx-project.json file contains only one package directory, it must be the default. Remove the `"default": false` key and try again.
+
+# targetOrg
+
+Username or alias of the org that all commands run against by default. (sf only)
+
+# targetDevHub
+
+Username or alias of your default Dev Hub org. (sf only)
+
+# defaultUsername
+
+Username or alias of the org that all commands run against by default. (sfdx only)
+
+# defaultDevHubUsername
+
+Username or alias of your default Dev Hub org. (sfdx only)
+
+# isvDebuggerSid
+
+ISV debugger SID
+
+# isvDebuggerUrl
+
+ISV debugger URL
+
+# apiVersion
+
+API version of your project. Default: API version of your Dev Hub org.
+
+# disableTelemetry
+
+Disables the collection of usage and user environment information, etc. Default: true.
+
+# maxQueryLimit
+
+Maximum number of Salesforce records returned by a CLI command. Default: 10,000.
+
+# restDeploy
+
+Whether deployments use the Metadata REST API (true) or SOAP API (false, default value).
+
+# instanceUrl
+
+URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com.

package/messages/core.json

@@ -12,9 +12,9 @@
   "OrgDataNotAvailableErrorAction2": "Use `sfdx force:config:set` to update the defaultusername.",
   "OrgDataNotAvailableErrorAction3": "Use `sfdx force:org:create` to create a new org.",
   "OrgDataNotAvailableErrorAction4": "Use `sfdx force:auth` to authenticate an existing org.",
-  "NamedOrgNotFound": "No AuthInfo found for name %s",
-  "NoAliasesFound": "Nothing to set",
-  "InvalidFormat": "Setting aliases must be in the format <key>=<value> but found: [%s]",
+  "NamedOrgNotFound": "No authorization information found for %s %s.",
+  "NoAliasesFound": "Nothing to set.",
+  "InvalidFormat": "Setting aliases must be in the format <key>=<value> but found: [%s].",
   "NoAuthInfoFound": "No authorization information can be found.",
   "InvalidJsonCasing": "All JSON input must have heads down camelcase keys.  E.g., { sfdcLoginUrl: \"https://login.salesforce.com\" }\nFound \"%s\" at %s"
 }

package/messages/core.md

@@ -41,7 +41,7 @@ An attempt to refresh the authentication token failed with a 'Data Not Found Err
 
 # namedOrgNotFound
 
-No AuthInfo found for name %s.
+No authorization information found for %s.
 
 # noAliasesFound
 

package/messages/envVars.md

@@ -0,0 +1,279 @@
+# forceOpenUrl
+
+Web page that opens in your browser when you connect to an org. For example, to open Lightning Experience, set to "lightning".
+
+# forceShowSpinner
+
+Set to true to show a spinner animation on the command line when running asynchronous CLI commands. Default is false.
+
+# forceSpinnerDelay
+
+Speed of the spinner in milliseconds. Default is 60.
+
+# httpProxy
+
+HTTP URL and port of the proxy server when using Salesforce CLI behind a corporate firewall or web proxy.
+
+# httpsProxy
+
+HTTPS URL and port of the proxy server when using Salesforce CLI behind a corporate firewall or web proxy.
+
+# nodeExtraCaCerts
+
+Fully qualified path to your self-signed certificate. Will be installed after you run "sfdx update".
+
+# nodeTlsRejectUnauthorized
+
+Set to 0 to allow Node.js to use the self-signed certificate in the certificate chain.
+
+# sfdxAccessToken
+
+Specifies an access token when using the auth:accesstoken:store command.
+
+# sfdxApiVersion
+
+The API version for a specific project or all projects. Default value is the API version of your Dev Hub. Overrides the apiVersion config value.
+
+# sfdxAudienceUrl
+
+URL that overrides the aud (audience) field used for JWT authentication so that it matches the expected value of the authorization server URL for the org you’re logging into.
+
+# sfdxCodeCoverageRequirement
+
+Code coverage percentages that are displayed in green when you run force:apex:test:\* with the --codecoverage parameter.
+
+# sfdxContentType
+
+Set to JSON so that all CLI commands output results in JSON format.
+
+# sfdxDefaultdevhubusername
+
+Username or alias of your default Dev Hub org. Overrides the defaultdevhubusername configuration value.
+
+# sfdxDefaultusername
+
+Username or alias of your default org. Overrides the defaultusername configuration value.
+
+# sfdxDisableAutoupdate
+
+Set to true to disable the auto-update feature of Salesforce CLI. Default value is false.
+
+# sfdxAutoupdateDisable
+
+Set to true to disable the auto-update feature of Salesforce CLI. Default value is false.
+
+# sfdxDisableSourceMemberPolling
+
+Set to true to disable polling of your org’s SourceMember object when you run the force:source:push|pull commands. Default value is false.
+
+# sfdxDisableTelemetry
+
+Set to true to disable Salesforce CLI from collecting usage information, user environment information, and crash reports. Default value is false. Overrides the disableTelemetry configration variable.
+
+# sfdxDnsTimeout
+
+Number of seconds that the force:org:\* commands wait for a response when checking whether an org is connected. Default value is 3.
+
+# sfdxDomainRetry
+
+Time, in seconds, that Salesforce CLI waits for the Lightning Experience custom domain to resolve and become available in a scratch org. Default value is 240.
+
+# sfdxImprovedCodeCoverage
+
+Set to true to scope Apex test results to the classes entered during a test run when running force:apex:test:\*.
+
+# sfdxInstanceUrl
+
+URL of the Salesforce instance that is hosting your org. Default value is https://login.salesforce.com. Overrides the instanceUrl configuration value.
+
+# sfdxJsonToStdout
+
+Set to true to send messages resulting from failed Salesforce CLI commands to stdout instead of stderr.
+
+# sfdxLogLevel
+
+Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn.
+
+# sfdxMaxQueryLimit
+
+Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration value.
+
+# sfdxMdapiTempDir
+
+Directory that contains files (in metadata format) when running certain Salesforce CLI commands, such as force:source:\*.
+
+# sfdxNpmRegistry
+
+URL to a private npm server, where all packages that you publish are private.
+
+# sfdxPrecompileEnable
+
+Set to true to enable Apex pre-compile before the tests are run with the force:apex:test:run command. Default is false.
+
+# sfdxProjectAutoupdateDisableForPackageCreate
+
+Set to true to disable automatic updates to sfdx-project.json when running force:package:create.
+
+# sfdxProjectAutoupdateDisableForPackageVersionCreate
+
+Set to true to disable automatic updates to sfdx-project.json when running force:package:version:create.
+
+# sfdxRestDeploy
+
+Set to true to make Salesforce CLI use the Metadata REST API for deployments. By default, the CLI uses SOAP.
+
+# sfdxSourceMemberPollingTimeout
+
+Number of seconds you want the force:source:push command to keep polling the SourceMember object before the command times out.
+
+# sfdxUseGenericUnixKeychain
+
+(Linux and macOS only) Set to true if you want to use the generic UNIX keychain instead of the Linux libsecret library or macOS keychain.
+
+# sfdxUseProgressBar
+
+Set to false to disable the progress bar when running force:mdapi:deploy, force:source:deploy, or force:source:push.
+
+# sfdxLazyLoadModules
+
+Set to true to enable lazy loading of sfdx modules
+
+# sfdxS3Host
+
+URL to S3 host
+
+# sfdxUpdateInstructions
+
+Text that describes how to update sfdx
+
+# sfdxInstaller
+
+Boolean indicating that the installer is running
+
+# sfdxEnv
+
+Describes if sfdx is in "demo" mode
+
+# sfTargetOrg
+
+Username or alias of your default org. Overrides the target-org configuration variable.
+
+# sfTargetDevHub
+
+Username or alias of your default Dev Hub org. Overrides the target-dev-hub configuration variable.
+
+# sfAccessToken
+
+Specifies an access token when using a login command that uses access tokens.
+
+# sfApiVersion
+
+API version for a specific project or all projects. Default value is the API version of your Dev Hub. Overrides the apiVersion configuration variable.
+
+# sfAudienceUrl
+
+URL that overrides the aud (audience) field used for JWT authentication so that it matches the expected value of the authorization server URL for the org you’re logging into.
+
+# sfCodeCoverageRequirement
+
+Code coverage percentages that are displayed in green when you run the Apex test CLIcommands with the --code-coverage flag.
+
+# sfContentType
+
+Set to JSON so that all CLI commands output results in JSON format.
+
+# sfDisableAutoupdate
+
+Set to true to disable the auto-update feature of Salesforce CLI. Default value is false.
+
+# sfAutoupdateDisable
+
+Set to true to disable the auto-update feature of Salesforce CLI. Default value is false.
+
+# sfDisableSourceMemberPolling
+
+Set to true to disable polling of your org’s SourceMember object when you run the commands to push and pull source. Default value is false.
+
+# sfDisableTelemetry
+
+Set to true to disable Salesforce CLI from collecting usage information, user environment information, and crash reports. Default value is false. Overrides the disableTelemetry configration variable.
+
+# sfDnsTimeout
+
+Number of seconds that the env commands wait for a response when checking whether an org is connected. Default value is 3.
+
+# sfDomainRetry
+
+Time, in seconds, that Salesforce CLI waits for the Lightning Experience custom domain to resolve and become available in a scratch org. Default value is 240.
+
+# sfImprovedCodeCoverage
+
+Set to true to scope Apex test results to the classes entered during a test run when running the Apex test commands.
+
+# sfInstanceUrl
+
+URL of the Salesforce instance that is hosting your org. Default value is https://login.salesforce.com. Overrides the instanceUrl configuration variable.
+
+# sfJsonToStdout
+
+Set to true to send messages resulting from failed Salesforce CLI commands to stdout instead of stderr.
+
+# sfLogLevel
+
+Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn.
+
+# sfMaxQueryLimit
+
+Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration variable.
+
+# sfMdapiTempDir
+
+Directory that contains files (in metadata format) when running certain Salesforce CLI commands.
+
+# sfNpmRegistry
+
+URL to a private npm server, where all packages that you publish are private.
+
+# sfPrecompileEnable
+
+Set to true to enable Apex pre-compile before the tests are run with the Apex test run command. Default is false.
+
+# sfProjectAutoupdateDisableForPackageCreate
+
+Set to true to disable automatic updates to sfdx-project.json when running the package create command.
+
+# sfProjectAutoupdateDisableForPackageVersionCreate
+
+Set to true to disable automatic updates to sfdx-project.json when running the package version create command.
+
+# sfSourceMemberPollingTimeout
+
+Number of seconds you want the source push command to keep polling the SourceMember object before the command times out.
+
+# sfUseGenericUnixKeychain
+
+(Linux and macOS only) Set to true if you want to use the generic UNIX keychain instead of the Linux libsecret library or macOS keychain.
+
+# sfUseProgressBar
+
+Set to false to disable the progress bar when running the metadata deploy command.
+
+# sfLazyLoadModules
+
+Set to true to enable lazy loading of sf modules
+
+# sfS3Host
+
+URL to S3 host
+
+# sfUpdateInstructions
+
+Text that describes how to update sf
+
+# sfInstaller
+
+Boolean indicating that the installer is running
+
+# sfEnv
+
+Describes if sf is in "demo" mode

package/messages/org.md

@@ -1,3 +1,47 @@
 # notADevHub
 
 The provided dev hub username %s is not a valid dev hub.
+
+# noUsernameFound
+
+No username found.
+
+# noDevHubFound
+
+Unable to associate this scratch org with a DevHub.
+
+# deleteOrgHubError
+
+The Dev Hub org cannot be deleted.
+
+# insufficientAccessToDelete
+
+You do not have the appropriate permissions to delete a scratch org. Please contact your Salesforce admin.
+
+# scratchOrgNotFound
+
+Attempting to delete an expired or deleted org
+
+# sandboxDeleteFailed
+
+The sandbox org deletion failed with a result of %s.
+
+# sandboxNotFound
+
+We can't find a SandboxProcess for the sandbox org %s.
+
+# sandboxInfoCreateFailed
+
+The sandbox org creation failed with a result of %s.
+
+# missingAuthUsername
+
+The sandbox %s does not have an authorized username.
+
+# orgPollingTimeout
+
+Sandbox status is %s; timed out waiting for completion.
+
+# NotFoundOnDevHub
+
+The scratch org does not belong to the dev hub username %s.

package/messages/scratchOrgCreate.md

@@ -0,0 +1,27 @@
+# UnsupportedSnapshotOrgCreateOptionsError
+
+Org snapshots don’t support one or more options you specified: %s.
+
+# SourceStatusResetFailureError
+
+Successfully created org with ID: %s and name: %s. Unfortunately, source tracking isn’t working as expected. If you run force:source:status, the results may be incorrect. Try again by creating another scratch org.
+
+# DurationDaysValidationMinError
+
+Expected 'durationDays' greater than or equal to %s but received %s.
+
+# DurationDaysValidationMaxError
+
+Expected 'durationDays' less than or equal to %s but received %s.
+
+# DurationDaysNotIntError
+
+Expected 'durationDays' to be an integer number.
+
+# RetryNotIntError
+
+Expected 'retry' to be an integer number.
+
+# WaitValidationMaxError
+
+Expected 'wait' greater than or equal to %s but received %s.

package/messages/scratchOrgErrorCodes.md

@@ -0,0 +1,99 @@
+# SignupFailedError
+
+The request to create a scratch org failed with error code: %s.
+
+# SignupFailedUnknownError
+
+An unknown server error occurred. Please try again. If you still see this error, contact Salesforce support for assistance. Include the information from 'sfdx force:data:record:get -s ScratchOrgInfo -i %s -u %s'.
+
+# SignupFailedActionError
+
+See https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_signuprequest.htm for information on error code %s.
+
+# SignupUnexpectedError
+
+The request to create a scratch org returned an unexpected status
+
+# INVALID_ID_FIELD
+
+Provide a valid template ID, in the format 0TTxxxxxxxxxxxx.
+
+# T-0002
+
+We couldn’t find a template or snapshot with the ID or name specified in the scratch org definition. If you’re sure the ID is correct, contact Salesforce Support.
+
+# T-0003
+
+The template specified in the scratch org definition is unapproved. Contact Salesforce Support to request template approval.
+
+# T-0004
+
+The Trialforce Source Organization (TSO) for the template doesn’t exist or has expired.
+
+# S-1006
+
+Provide a valid email address in your scratch org definition or your %s file.
+
+# S-2006
+
+Provide a valid country code in your scratch org definition or your %s file.
+
+# S-1017
+
+Specify a namespace that’s used by a release org associated with your Dev Hub org.
+
+# S-1018
+
+Provide a valid My Domain value. This value can’t include double hyphens, end in a hyphen, include restricted words, or be more than 40 characters long.
+
+# S-1019
+
+The My Domain value you chose is already in use.
+
+# S-1026
+
+Provide a valid namespace value. This value must begin with a letter. It can’t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed.
+
+# S-9999
+
+A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance.
+
+# SH-0001
+
+Can’t create scratch org. Contact the source org admin to add your Dev Hub org ID to Setup > Org Shape. Then try again.
+
+# SH-0002
+
+Can’t create scratch org. No org shape exists for the specified sourceOrg. Create an org shape and try again.
+
+# SH-0003
+
+Can’t create scratch org from org shape. The org shape version is outdated. Recreate the org shape and try again.
+
+# C-1007
+
+The username provided to the org:create command is already in use. Run 'force:org:list --clean' to remove stale org authentications or create the org with a different username.
+
+# C-1015
+
+We encountered a problem while registering your My Domain value with the DNS provider. Please try again.
+
+# C-1016
+
+We encountered a problem while attempting to configure and approve the Connected App for your org. Verify the Connected App configuration with your Salesforce admin.
+
+# C-1017
+
+Provide a valid namespace prefix. This value must begin with a letter. It can’t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed.
+
+# C-1020
+
+We couldn't find a template with the ID specified in the scratch org definition. If you’re sure the ID is correct, contact Salesforce Support.
+
+# C-1027
+
+The template specified in the Scratch Definition isn’t supported. Specify a generic edition (such as Developer or Enterprise), or specify a template ID.
+
+# C-9999
+
+A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance

package/messages/scratchOrgFeatureDeprecation.md

@@ -0,0 +1,11 @@
+# quantifiedFeatureWithoutQuantityWarning
+
+The feature %s will be deprecated in a future release. It's been replaced by %s:<value>, which requires you to specify a quantity.
+
+# mappedFeatureWarning
+
+The feature %s has been deprecated. It has been replaced with %s in this scratch org create request.
+
+# deprecatedFeatureWarning
+
+The feature %s has been deprecated. It has been removed from the list of requested features.

package/messages/scratchOrgInfoApi.md

@@ -0,0 +1,11 @@
+# SignupFieldsMissingError
+
+Required fields are missing for org creation: [%s]
+
+# SignupDuplicateSettingsSpecifiedError
+
+You cannot use 'settings' and `'orgPreferences' in your scratch definition file, please specify one or the other.
+
+# DeprecatedPrefFormat
+
+We've deprecated OrgPreferences. Update the scratch org definition file to replace OrgPreferences with their corresponding settings.