feat(cli-plugin-contract): introduce a public contract between CLI and plugins

[otaviomacedo]

The contract between the CLI and credential provider plugins is not publicly defined.

Extract the types involved in the CLI-plugin communication into a new package, @aws-cdk/cli-plugin-contract, and update all references in the CLI code.

Closes #32099.

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.31%. Comparing base (f598885) to head (d7b671a).

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32111      +/-   ##
==========================================
+ Coverage   77.30%   77.31%   +0.01%     
==========================================
  Files         114      113       -1     
  Lines        7627     7623       -4     
  Branches     1360     1359       -1     
==========================================
- Hits         5896     5894       -2     
+ Misses       1549     1547       -2     
  Partials      182      182              

Flag	Coverage Δ
suite.unit	77.31% <100.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	77.31% <100.00%> (+0.01%)	⬆️

[mrgrain]

We change this to a strongly typed string, we can make this package types only.

Suggested change

	getProvider(accountId: string, mode: Mode): Promise<AwsCredentials>;
	getProvider(accountId: string, mode: 'ForReading' | 'ForWriting'): Promise<AwsCredentials>;

[otaviomacedo]

This would be a breaking change for plugins, which are expecting a number (ForReading = 0, ForWriting = 1).

[aws-cdk-automation]

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

[aws-cdk-automation]

The pull request linter fails with the following errors:

❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/32111/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 16d3d4d
• Result: FAILED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository