@salesforce/plugin-deploy-retrieve 1.3.0 → 1.4.0

package/lib/utils/types.d.ts

@@ -1,3 +1,4 @@
+import { FileResponse, MetadataApiDeployStatus, MetadataApiRetrieveStatus, RequestStatus } from '@salesforce/source-deploy-retrieve';
 export declare enum TestLevel {
     NoTestRun = "NoTestRun",
     RunSpecifiedTests = "RunSpecifiedTests",
@@ -8,9 +9,14 @@ export declare enum API {
     SOAP = "SOAP",
     REST = "REST"
 }
-export declare type TestResults = {
-    passing: number;
-    failing: number;
-    total: number;
-    time?: string;
+export declare type Verbosity = 'verbose' | 'concise' | 'normal';
+export declare type AsyncDeployResultJson = Omit<Partial<MetadataApiDeployStatus>, 'status'> & {
+    status: RequestStatus | 'Queued';
+    files: FileResponse[];
+};
+export declare type DeployResultJson = (MetadataApiDeployStatus & {
+    files: FileResponse[];
+}) | AsyncDeployResultJson;
+export declare type RetrieveResultJson = MetadataApiRetrieveStatus & {
+    files: FileResponse[];
 };

package/lib/utils/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,kDAAqC,CAAA;AACvC,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AAED,IAAY,GAGX;AAHD,WAAY,GAAG;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;AACf,CAAC,EAHW,GAAG,GAAH,WAAG,KAAH,WAAG,QAGd"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AASH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,kDAAqC,CAAA;AACvC,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AAED,IAAY,GAGX;AAHD,WAAY,GAAG;IACb,oBAAa,CAAA;IACb,oBAAa,CAAA;AACf,CAAC,EAHW,GAAG,GAAH,WAAG,KAAH,WAAG,QAGd"}

package/messages/cache.md

@@ -0,0 +1,7 @@
+# error.InvalidJobId
+
+No job found for ID: %s.
+
+# error.NoRecentJobId
+
+There are no recent job IDs available.

package/messages/config.md

@@ -0,0 +1,7 @@
+# error.invalidBooleanConfigValue
+
+The config value can only be set to true or false
+
+# org-metadata-rest-deploy
+
+Whether deployments use the Metadata REST API (true) or SOAP API (false, default value).

package/messages/deploy.async.md

@@ -0,0 +1,19 @@
+# info.AsyncDeployQueued
+
+Deploy has been queued.
+
+# info.AsyncDeployCancelQueued
+
+Deploy has been queued for cancellation.
+
+# info.AsyncDeployCancel
+
+Run "sf deploy metadata cancel --job-id %s" to cancel the deploy.
+
+# info.AsyncDeployStatus
+
+Run "sf deploy metadata report --job-id %s" to get the latest status.
+
+# info.AsyncDeployResume
+
+Run "sf deploy metadata resume --job-id %s" to resume watching the deploy.

package/messages/deploy.metadata.cancel.md

@@ -0,0 +1,62 @@
+# summary
+
+Cancel a deploy operation.
+
+# description
+
+Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.
+
+Run this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.
+
+# examples
+
+- Cancel a deploy operation using a job ID:
+
+      <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
+
+- Cancel the most recent deploy operation:
+
+      <%= config.bin %> <%= command.id %> --use-most-recent
+
+# flags.job-id.summary
+
+Job ID of the deploy operation you want to cancel.
+
+# flags.job-id.description
+
+These commands return a job ID if they time out or you specified the --async flag:
+
+- sf deploy metadata
+- sf deploy metadata validate
+- sf deploy metadata quick
+- sf deploy metadata cancel
+
+The job ID is valid for 10 days from when you started the deploy operation.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the most recent deploy operation.
+
+# flags.use-most-recent.description
+
+For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.
+
+# flags.wait.summary
+
+Number of minutes to wait for the command to complete and display results.
+
+# flags.wait.description
+
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run "sf deploy metadata resume". To check the status of the cancellation, run "sf deploy metadata report".
+
+# flags.async.summary
+
+Run the command asynchronously.
+
+# flags.async.description
+
+The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run "sf deploy metadata resume". To check the status of the cancellation, run "sf deploy metadata report".
+
+# error.CannotCancelDeploy
+
+Can't cancel deploy because it's already completed.

package/messages/deploy.metadata.md

@@ -8,8 +8,6 @@ You must run this command from within a project.
 
 This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.
 
-To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue to use the CLI.
-
 To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
 
 # examples
@@ -94,7 +92,7 @@ Number of minutes to wait for command to complete and display results.
 
 # flags.wait.description
 
-If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run "sf deploy metadata resume". To check the status of the deployment, run "sf deploy metadata report".
 
 # flags.manifest.summary
 
@@ -136,6 +134,10 @@ Separate multiple test names with commas, and enclose the entire flag value in d
 
 Show verbose output of the deploy result.
 
+# flags.concise.summary
+
+Show concise output of the deploy result.
+
 # flags.api-version.summary
 
 Target API version for the deploy.
@@ -144,6 +146,14 @@ Target API version for the deploy.
 
 Use this flag to override the default API version, which is the latest version supported the CLI, with the API version of your package.xml file.
 
+# flags.async.summary
+
+Run the command asynchronously.
+
+# flags.async.description
+
+The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run "sf deploy metadata resume". To check the status of the deployment, run "sf deploy metadata report".
+
 # save.as.default
 
 Save %s as default target-org?
@@ -161,6 +171,10 @@ The target-org found in the configuration is expired. The user terminated the de
 
 You must specify tests using the --tests flag if the --test-level flag is set to RunSpecifiedTests.
 
+# error.ClientTimeout
+
+The client has timed out. Use sf deploy metadata resume to resume watching this deploy.
+
 # warning.TargetOrgIsExpired
 
 The target-org, "%s", is expired. Do you want to pick another org?

package/messages/deploy.metadata.quick.md

@@ -0,0 +1,81 @@
+# summary
+
+Quickly deploy a validated deployment to an org.
+
+# description
+
+Before you run this command, first create a validated deployment with the "sf deploy metadata validate" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.
+
+Executing this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.
+
+This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.
+
+# examples
+
+- Run a quick deploy to your default org using a job ID:
+
+      <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
+
+- Asynchronously run a quick deploy of the most recently validated deployment to an org with alias "my-prod-org":
+
+      <%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org
+
+# flags.job-id.summary
+
+Job ID of the deployment you want to quick deploy.
+
+# flags.job-id.description
+
+The job ID is valid for 10 days from when you started the validation.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the most recently validated deployment.
+
+# flags.use-most-recent.description
+
+For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find a job ID.
+
+# flags.wait.summary
+
+Number of minutes to wait for the command to complete and display results.
+
+# flags.wait.description
+
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run "sf deploy metadata resume". To check the status of the deploy, run "sf deploy metadata report".
+
+# flags.verbose.summary
+
+Show verbose output of the deploy result.
+
+# flags.concise.summary
+
+Show concise output of the deploy result.
+
+# flags.async.summary
+
+Run the command asynchronously.
+
+# flags.async.description
+
+The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run "sf deploy metadata resume". To check the status of the deploy, run "sf deploy metadata report".
+
+# flags.target-org.summary
+
+Login username or alias for the target org.
+
+# flags.target-org.description
+
+Overrides your default org.
+
+# error.CannotQuickDeploy
+
+Job ID can't be used for quick deployment. Possible reasons include the deployment hasn't been validated or the validation expired because you ran it more than 10 days ago.
+
+# error.QuickDeployFailure
+
+Deployment %s exited with status code: %s.
+
+# info.QuickDeploySuccess
+
+Successfully deployed (%s).

package/messages/deploy.metadata.report.md

@@ -0,0 +1,42 @@
+# summary
+
+Check the status of a deploy operation.
+
+# description
+
+Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.
+
+Run this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.
+
+# examples
+
+- Check the status using a job ID:
+
+      <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
+
+- Check the status of the most recent deploy operation:
+
+      <%= config.bin %> <%= command.id %> --use-most-recent
+
+# flags.job-id.summary
+
+Job ID of the deploy operation you want to check the status of.
+
+# flags.job-id.description
+
+These commands return a job ID if they time out or you specified the --async flag:
+
+- sf deploy metadata
+- sf deploy metadata validate
+- sf deploy metadata quick
+- sf deploy metadata cancel
+
+The job ID is valid for 10 days from when you started the deploy operation.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the most recent deploy operation.
+
+# flags.use-most-recent.description
+
+For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.

package/messages/deploy.metadata.resume.md

@@ -0,0 +1,58 @@
+# summary
+
+Resume watching a deploy operation.
+
+# description
+
+Use this command to resume watching a deploy operation if the original command times out or you specified the --async flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This command doesn't resume the original operation itself, because the operation always continues after you've started it, regardless of whether you're watching it or not.
+
+Run this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.
+
+# examples
+
+- Resume watching a deploy operation using a job ID:
+
+      <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
+
+- Resume watching the most recent deploy operation:
+
+      <%= config.bin %> <%= command.id %> --use-most-recent
+
+# flags.job-id.summary
+
+Job ID of the deploy operation you want to resume.
+
+# flags.job-id.description
+
+These commands return a job ID if they time out or you specified the --async flag:
+
+- sf deploy metadata
+- sf deploy metadata validate
+- sf deploy metadata quick
+- sf deploy metadata cancel
+
+The job ID is valid for 10 days from when you started the deploy operation.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the most recent deploy operation.
+
+# flags.use-most-recent.description
+
+For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.
+
+# flags.wait.summary
+
+Number of minutes to wait for the command to complete and display results.
+
+# flags.wait.description
+
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy operation, run this command again. To check the status of the deploy operation, run "sf deploy metadata report".
+
+# flags.verbose.summary
+
+Show verbose output of the deploy operation result.
+
+# flags.concise.summary
+
+Show concise output of the deploy operation result.

package/messages/deploy.metadata.validate.md

@@ -0,0 +1,123 @@
+# summary
+
+Validate a metadata deployment without actually executing it.
+
+# description
+
+Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to "sf deploy metadata", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the "sf deploy metadata quick" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.
+
+You must run this command from within a project.
+
+This command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.
+
+To validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
+
+# examples
+
+- NOTE: These examples focus on validating large deployments.  See the help for "sf deploy metadata" for examples of deploying smaller sets of metadata which you can also use to validate.
+
+- Validate the deployment of all source files in a directory to the default org:
+
+      <%= config.bin %> <%= command.id %> --source-dir path/to/source
+
+- Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately returns the job ID:
+
+      <%= config.bin %> <%= command.id %> --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org my-prod-org
+
+- Validate the deployment of all components listed in a manifest:
+
+      <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
+
+# flags.target-org.summary
+
+Login username or alias for the target org.
+
+# flags.target-org.description
+
+Overrides your default org.
+
+# flags.metadata.summary
+
+Metadata component names to validate for deployment.
+
+# flags.test-level.summary
+
+Deployment Apex testing level.
+
+# flags.test-level.description
+
+Valid values are:
+
+- RunSpecifiedTests — Runs only the tests that you specify with the --run-tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.
+
+- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.
+
+- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
+  
+If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the "Metadata API Developer Guide".
+        
+# flags.source-dir.summary
+
+Path to the local source files to validate for deployment.
+
+# flags.source-dir.description
+
+The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).
+
+If you specify this flag, don’t specify --metadata or --manifest.
+
+# flags.wait.summary
+
+Number of minutes to wait for the command to complete and display results.
+
+# flags.wait.description
+
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume watching the validation, run "sf deploy metadata resume". To check the status of the validation, run "sf deploy metadata report".
+
+# flags.manifest.summary
+
+Full file path for manifest (package.xml) of components to validate for deployment.
+
+# flags.manifest.description
+
+All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
+
+# flags.api.summary
+
+The API to use for validating the deployment.
+
+# flags.tests.summary
+
+Apex tests to run when --test-level is RunSpecifiedTests.
+
+# flags.verbose.summary
+
+Show verbose output of the validation result.
+
+# flags.concise.summary
+
+Show concise output of the validation result.
+
+# flags.api-version.summary
+
+Target API version for the validation.
+
+# flags.api-version.description
+
+Use this flag to override the default API version, which is the latest version supported the CLI, with the API version in your package.xml file.
+
+# flags.async.summary
+
+Run the command asynchronously.
+
+# flags.async.description
+
+The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run "sf deploy metadata resume". To check the status of the validation, run "sf deploy metadata report".
+
+# info.SuccessfulValidation
+
+Successfully validated the deployment (%s).
+
+# error.FailedValidation
+
+Falied to validate the deployment (%s).

package/messages/errorCodes.md

@@ -0,0 +1,27 @@
+# errorCode.deploy.Succeeded
+
+The deploy succeeded.
+
+# errorCode.deploy.Canceled
+
+The deploy was canceled.
+
+# errorCode.deploy.Failed
+
+The deploy failed.
+
+# errorCode.deploy.SucceededPartial
+
+The deploy partially succeeded.
+
+# errorCode.deploy.InProgress
+
+The deploy is in progress.
+
+# errorCode.deploy.Pending
+
+The deploy is pending.
+
+# errorCode.deploy.Canceling
+
+The deploy is being canceled.