@codedrifters/configulator 0.0.317 → 0.0.319

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -81,7 +81,7 @@ declare const AGENT_PLATFORM: {
81
81
  type AgentPlatform = (typeof AGENT_PLATFORM)[keyof typeof AGENT_PLATFORM];
82
82
  /**
83
83
  * Render target for Claude Code rules.
84
- * - SCOPED_FILE: .claude/rules/{name}.md (default — supports paths frontmatter for conditional activation)
84
+ * - SCOPED_FILE: `.claude/rules/{name}.md` (default — supports paths frontmatter for conditional activation)
85
85
  * - AGENTS_MD: AGENTS.md (always-active, shared with Codex)
86
86
  * - CLAUDE_MD: CLAUDE.md (always-active, Claude-only content not consumed by other agents)
87
87
  */
@@ -131,7 +131,7 @@ interface AgentPlatformOverrides {
131
131
  readonly claude?: {
132
132
  /**
133
133
  * Where to render this rule for Claude Code.
134
- * - SCOPED_FILE: .claude/rules/{name}.md (default — supports paths frontmatter)
134
+ * - SCOPED_FILE: `.claude/rules/{name}.md` (default — supports paths frontmatter)
135
135
  * - AGENTS_MD: AGENTS.md (always-active, shared with Codex)
136
136
  * - CLAUDE_MD: CLAUDE.md (always-active, Claude-only)
137
137
  */
@@ -269,10 +269,12 @@ interface AgentSkill {
269
269
  * files for that platform alongside the SKILL.md.
270
270
  *
271
271
  * @example
272
+ * ```ts
272
273
  * referenceFiles: [
273
274
  * { path: '_references/templates/_template-FR.md', content: '# Functional Requirement\n...' },
274
275
  * { path: '_references/standards-and-frameworks.md', content: '# Standards\n...' },
275
276
  * ]
277
+ * ```
276
278
  */
277
279
  readonly referenceFiles?: ReadonlyArray<{
278
280
  /** Path relative to the skill directory (e.g., `_references/templates/_template-FR.md`). */
@@ -452,7 +454,7 @@ interface AgentCommand {
452
454
  }
453
455
  /**
454
456
  * An executable procedure (shell script) that ships with a bundle.
455
- * Rendered to .claude/procedures/{name} as an executable file.
457
+ * Rendered to `.claude/procedures/{name}` as an executable file.
456
458
  */
457
459
  interface AgentProcedure {
458
460
  /**
@@ -580,7 +582,7 @@ interface AgentRuleBundle {
580
582
  * Function that inspects the Projen project and returns true if this
581
583
  * bundle should be automatically included. Receives the root project
582
584
  * as input and can check for sibling components, dependencies, etc.
583
- * @example (project) => Vitest.of(project) !== undefined
585
+ * @example `(project) => Vitest.of(project) !== undefined`
584
586
  */
585
587
  readonly appliesWhen: (project: Project$1) => boolean;
586
588
  /**
@@ -593,7 +595,7 @@ interface AgentRuleBundle {
593
595
  * TypeScript-adjacent code (e.g. typescript, aws-cdk, vitest, jest) should
594
596
  * implement this so their rules only activate for files in the packages
595
597
  * that actually use them.
596
- * @example (project) => findProjectsWithFile(project, 'tsconfig.json')
598
+ * @example `(project) => findProjectsWithFile(project, 'tsconfig.json')`
597
599
  */
598
600
  readonly findApplicableProjects?: (project: Project$1) => ReadonlyArray<Project$1>;
599
601
  /** Rules included in this bundle. */
@@ -1380,11 +1382,11 @@ interface MeetingType {
1380
1382
  * edits on that meeting (see the `meeting-analyst` agent's
1381
1383
  * **Areas filtering** section for the full gating contract).
1382
1384
  *
1383
- * Example: declaring `{ id: 'product-engineering', label: 'Product &
1384
- * Engineering', docRoot: 'product' }` tells the `meeting-analysis`
1385
- * bundle that a meeting whose frontmatter carries
1386
- * `areas: [product-engineering]` should have its direct edits routed
1387
- * under `<docsRoot>/product/`.
1385
+ * Example: declaring
1386
+ * `{ id: 'product-engineering', label: 'Product & Engineering', docRoot: 'product' }`
1387
+ * tells the `meeting-analysis` bundle that a meeting whose frontmatter
1388
+ * carries `areas: [product-engineering]` should have its direct edits
1389
+ * routed under `<docsRoot>/product/`.
1388
1390
  *
1389
1391
  * When `AgentConfigOptions.meetings.meetingAreas` is non-empty, the
1390
1392
  * `meeting-analysis` bundle renders an "Area → doc-root mapping"
@@ -2877,7 +2879,7 @@ interface AgentConfigOptions {
2877
2879
  * match one of the six tier-aware bundle names — typos or
2878
2880
  * deprecated bundle names would otherwise be silently ignored.
2879
2881
  *
2880
- * @default {}
2882
+ * @default `{}`
2881
2883
  */
2882
2884
  readonly bundleAgentTiers?: Readonly<Record<string, "powerful" | "balanced" | "fast">>;
2883
2885
  /**
@@ -4467,7 +4469,7 @@ interface ResolvedScheduledTask {
4467
4469
  readonly typeLabel: string;
4468
4470
  /**
4469
4471
  * Exact `type:*` label values (without the `type:` prefix) the
4470
- * worker picks up. When set (length >= 1), represents a
4472
+ * worker picks up. When set (`length >= 1`), represents a
4471
4473
  * multi-type filter (e.g. routing-bucket `worker-issue`). When
4472
4474
  * unset, the `typeLabel` single-value filter applies.
4473
4475
  */
@@ -4481,7 +4483,7 @@ interface ResolvedScheduledTask {
4481
4483
  readonly phasePrefix?: string;
4482
4484
  /**
4483
4485
  * Exact phase-label values the worker filters on (e.g.
4484
- * `["req:write"]`). When set (length >= 1), takes precedence over
4486
+ * `["req:write"]`). When set (`length >= 1`), takes precedence over
4485
4487
  * `phasePrefix`. When unset, the `phasePrefix` prefix-match
4486
4488
  * applies.
4487
4489
  */
@@ -4934,10 +4936,10 @@ declare function validateAgentTierConfig(config?: AgentTierConfig): ReadonlyArra
4934
4936
  *
4935
4937
  * When `excludeBundles` is non-empty, rows whose `type:*` label is
4936
4938
  * owned by an excluded bundle are dropped before rendering. Tiers
4937
- * that end up with no surviving rows render an empty `_(none
4938
- * registered)_` cell for consistency with the existing render — the
4939
- * tier itself stays in the table so the dispatch ordering is still
4940
- * documented end-to-end.
4939
+ * that end up with no surviving rows render an empty
4940
+ * `_(none registered)_` cell for consistency with the existing
4941
+ * render — the tier itself stays in the table so the dispatch
4942
+ * ordering is still documented end-to-end.
4941
4943
  */
4942
4944
  declare function renderAgentTierSection(tiers: ReadonlyArray<ResolvedAgentTier>, excludeBundles?: ReadonlyArray<string>): string;
4943
4945
  /**
@@ -6416,7 +6418,7 @@ interface GitHubProjectMetadata {
6416
6418
  readonly sprints?: GitHubSprintMetadata;
6417
6419
  /**
6418
6420
  * Kanban column (status field) definitions.
6419
- * @example [{ name: 'To Do', id: 'status_1' }, { name: 'In Progress', id: 'status_2' }]
6421
+ * @example `[{ name: 'To Do', id: 'status_1' }, { name: 'In Progress', id: 'status_2' }]`
6420
6422
  */
6421
6423
  readonly columns?: ReadonlyArray<{
6422
6424
  readonly name: string;
@@ -6465,7 +6467,7 @@ interface SlackMetadata {
6465
6467
  readonly alertsChannel?: string;
6466
6468
  /**
6467
6469
  * Additional named channels. Keys are purpose identifiers.
6468
- * @example { releases: '#releases', support: '#customer-support' }
6470
+ * @example `{ releases: '#releases', support: '#customer-support' }`
6469
6471
  */
6470
6472
  readonly channels?: Readonly<Record<string, string>>;
6471
6473
  }
@@ -6490,7 +6492,7 @@ interface DeploymentMetadata {
6490
6492
  readonly awsRegion?: string;
6491
6493
  /**
6492
6494
  * Named environments.
6493
- * @example { dev: { accountId: '111', region: 'us-east-1' }, prod: { accountId: '222', region: 'us-east-1' } }
6495
+ * @example `{ dev: { accountId: '111', region: 'us-east-1' }, prod: { accountId: '222', region: 'us-east-1' } }`
6494
6496
  */
6495
6497
  readonly environments?: Readonly<Record<string, {
6496
6498
  readonly accountId?: string;
@@ -6763,7 +6765,7 @@ interface AstroIntegrationSpec {
6763
6765
  */
6764
6766
  readonly name: string;
6765
6767
  /**
6766
- * Module to import from, e.g. "@astrojs/react".
6768
+ * Module to import from, e.g. `@astrojs/react`.
6767
6769
  */
6768
6770
  readonly importPath: string;
6769
6771
  /**
@@ -6836,265 +6838,1672 @@ declare class AstroConfig extends Component {
6836
6838
 
6837
6839
  /*******************************************************************************
6838
6840
  *
6839
- * Git configs for this repo. This venn diagram has a great deal of overlap
6840
- * with GitHub config options but is not a perfect circle.
6841
+ * AWS CDK CLI Enums
6842
+ *
6843
+ * `as const` enums for the `cdk` CLI surface. Phase 1 covered `cdk deploy`;
6844
+ * Phase 2 adds the enum needed by `cdk diff`; Phase 3 adds the enums needed by
6845
+ * `cdk gc`; Phase 4 adds the enums needed by `cdk init` (and reused by `cdk
6846
+ * migrate`).
6841
6847
  *
6842
6848
  ******************************************************************************/
6843
- interface GitBranch {
6844
- /**
6845
- * The name of the branch pattern.
6846
- *
6847
- * @example "main" or "feature/*"
6848
- */
6849
- branch: string;
6850
- /**
6851
- * Description for this branch's purpose, used for generated documentation.
6852
- */
6853
- description?: Array<string>;
6854
- }
6849
+ /**
6850
+ * `--require-approval` values accepted by `cdk deploy`.
6851
+ */
6852
+ declare const CDK_REQUIRE_APPROVAL: {
6853
+ readonly Never: "never";
6854
+ readonly AnyChange: "any-change";
6855
+ readonly Broadening: "broadening";
6856
+ };
6857
+ /**
6858
+ * Type for {@link CDK_REQUIRE_APPROVAL} values.
6859
+ */
6860
+ type CdkRequireApproval = (typeof CDK_REQUIRE_APPROVAL)[keyof typeof CDK_REQUIRE_APPROVAL];
6861
+ /**
6862
+ * `--method` values accepted by `cdk deploy`.
6863
+ */
6864
+ declare const CDK_DEPLOY_METHOD: {
6865
+ readonly ChangeSet: "change-set";
6866
+ readonly Direct: "direct";
6867
+ readonly PrepareChangeSet: "prepare-change-set";
6868
+ readonly ExecuteChangeSet: "execute-change-set";
6869
+ };
6870
+ /**
6871
+ * Type for {@link CDK_DEPLOY_METHOD} values.
6872
+ */
6873
+ type CdkDeployMethod = (typeof CDK_DEPLOY_METHOD)[keyof typeof CDK_DEPLOY_METHOD];
6874
+ /**
6875
+ * `--progress` values accepted by `cdk deploy`.
6876
+ */
6877
+ declare const CDK_PROGRESS: {
6878
+ readonly Bar: "bar";
6879
+ readonly Events: "events";
6880
+ };
6881
+ /**
6882
+ * Type for {@link CDK_PROGRESS} values.
6883
+ */
6884
+ type CdkProgress = (typeof CDK_PROGRESS)[keyof typeof CDK_PROGRESS];
6885
+ /**
6886
+ * `--method` values accepted by `cdk diff`.
6887
+ */
6888
+ declare const CDK_DIFF_METHOD: {
6889
+ readonly Auto: "auto";
6890
+ readonly ChangeSet: "change-set";
6891
+ readonly Template: "template";
6892
+ };
6893
+ /**
6894
+ * Type for {@link CDK_DIFF_METHOD} values.
6895
+ */
6896
+ type CdkDiffMethod = (typeof CDK_DIFF_METHOD)[keyof typeof CDK_DIFF_METHOD];
6897
+ /**
6898
+ * `--action` values accepted by `cdk gc`.
6899
+ */
6900
+ declare const CDK_GC_ACTION: {
6901
+ readonly DeleteTagged: "delete-tagged";
6902
+ readonly Full: "full";
6903
+ readonly Print: "print";
6904
+ readonly Tag: "tag";
6905
+ };
6906
+ /**
6907
+ * Type for {@link CDK_GC_ACTION} values.
6908
+ */
6909
+ type CdkGcAction = (typeof CDK_GC_ACTION)[keyof typeof CDK_GC_ACTION];
6910
+ /**
6911
+ * `--type` values accepted by `cdk gc`.
6912
+ */
6913
+ declare const CDK_GC_TYPE: {
6914
+ readonly All: "all";
6915
+ readonly Ecr: "ecr";
6916
+ readonly S3: "s3";
6917
+ };
6918
+ /**
6919
+ * Type for {@link CDK_GC_TYPE} values.
6920
+ */
6921
+ type CdkGcType = (typeof CDK_GC_TYPE)[keyof typeof CDK_GC_TYPE];
6922
+ /**
6923
+ * Positional `<template>` values accepted by `cdk init`.
6924
+ */
6925
+ declare const CDK_INIT_TEMPLATE: {
6926
+ readonly App: "app";
6927
+ readonly Lib: "lib";
6928
+ readonly SampleApp: "sample-app";
6929
+ };
6930
+ /**
6931
+ * Type for {@link CDK_INIT_TEMPLATE} values.
6932
+ */
6933
+ type CdkInitTemplate = (typeof CDK_INIT_TEMPLATE)[keyof typeof CDK_INIT_TEMPLATE];
6934
+ /**
6935
+ * `--language` values accepted by `cdk init`. Also reused by `cdk migrate`'s
6936
+ * `--language` flag, which accepts the same set of language identifiers.
6937
+ */
6938
+ declare const CDK_INIT_LANGUAGE: {
6939
+ readonly CSharp: "csharp";
6940
+ readonly FSharp: "fsharp";
6941
+ readonly Go: "go";
6942
+ readonly Java: "java";
6943
+ readonly JavaScript: "javascript";
6944
+ readonly Python: "python";
6945
+ readonly TypeScript: "typescript";
6946
+ };
6947
+ /**
6948
+ * Type for {@link CDK_INIT_LANGUAGE} values.
6949
+ */
6950
+ type CdkInitLanguage = (typeof CDK_INIT_LANGUAGE)[keyof typeof CDK_INIT_LANGUAGE];
6855
6951
 
6856
6952
  /*******************************************************************************
6857
6953
  *
6858
- * AWS Deployment Configuration
6954
+ * AWS CDK CLI Options
6859
6955
  *
6860
- * A single deployment target that CDK applications can be deployed into.
6956
+ * Typed coverage of the `cdk` CLI surface. Phase 1 covered `deploy`; Phase 2
6957
+ * adds `synth`, `watch`, `destroy`, `diff`, `bootstrap`, and `list`; Phase 3
6958
+ * adds the maintenance / lifecycle commands `rollback`, `import`, `gc`,
6959
+ * `drift`, `refactor`, `publish-assets`, and `orphan`; Phase 4 adds the
6960
+ * inspection / scaffolding commands `init`, `migrate`, `context`, `metadata`,
6961
+ * `flags`, `acknowledge`, `notices`, `doctor`, and `docs`. Every
6962
+ * command-specific interface inherits {@link CdkGlobalOptions} so it carries
6963
+ * the same global flag surface.
6964
+ *
6965
+ * Every boolean field is tri-state (`boolean | undefined`):
6966
+ * - `undefined` → the renderer emits nothing, and the CLI's own default
6967
+ * applies.
6968
+ * - `true` → renders as `--flag`.
6969
+ * - `false` → renders as `--no-flag`.
6861
6970
  *
6862
6971
  ******************************************************************************/
6863
6972
  /**
6864
- * Represents the configuration for local deployment in AWS.
6973
+ * Global CLI flags accepted by every `cdk` subcommand. Command-specific option
6974
+ * interfaces extend this base so the global flag surface stays in lock-step
6975
+ * across commands.
6865
6976
  */
6866
- interface AwsLocalDeploymentConfig {
6867
- /**
6868
- * The AWS profile (in ~/.aws/config) to use for local deployment.
6977
+ interface CdkGlobalOptions {
6978
+ /*****************************************************************************
6869
6979
  *
6870
- * @default generated dynamically based role name, account and region
6980
+ * Global CLI flags
6981
+ *
6982
+ ****************************************************************************/
6983
+ /**
6984
+ * `--app` — path to the CDK cloud assembly (or the synth command).
6985
+ */
6986
+ readonly app?: string;
6987
+ /**
6988
+ * `--profile` — named AWS profile from `~/.aws/credentials`.
6871
6989
  */
6872
6990
  readonly profile?: string;
6873
6991
  /**
6874
- * Named Role used to conduct local deployments.
6875
- *
6876
- * @default "poweruseraccess"
6992
+ * `--lookups` whether the CLI may perform context lookups against the
6993
+ * target environment.
6877
6994
  */
6878
- readonly roleName?: string;
6995
+ readonly lookups?: boolean;
6879
6996
  /**
6880
- * The pattern used to identify stacks to deploy in CI deployments.
6881
- *
6882
- * @default *-${account}-${region}
6997
+ * `--context` CDK context values. Repeats one `--context` flag per
6998
+ * `KEY=VALUE` entry.
6883
6999
  */
6884
- readonly stackPattern?: string;
6885
- }
6886
- interface CiDeploymentConfig {
7000
+ readonly context?: Record<string, string>;
6887
7001
  /**
6888
- * The OIDC IAM Role to assume for CI deployments.
7002
+ * `--output` directory to read the cloud assembly from.
6889
7003
  */
6890
- readonly roleArn: string;
7004
+ readonly output?: string;
6891
7005
  /**
6892
- * The pattern used to identify stacks to deploy in CI deployments.
6893
- *
6894
- * @default *-${account}-${region}
7006
+ * `--verbose` (`-v`) verbosity level. The renderer emits `-v` repeated N
7007
+ * times.
6895
7008
  */
6896
- readonly stackPattern?: string;
6897
- }
6898
- /**
6899
- * Represents a deployment target in AWS, including account and region, and
6900
- * branches allowed to deploy to this target.
6901
- */
6902
- interface AwsDeploymentTargetOptions {
7009
+ readonly verbose?: number;
6903
7010
  /**
6904
- * The account name for the deployment target.
7011
+ * `--debug` enable debug output.
6905
7012
  */
6906
- readonly account: string;
7013
+ readonly debug?: boolean;
6907
7014
  /**
6908
- * The AWS region for the deployment target.
7015
+ * `--ci` non-interactive CI mode.
6909
7016
  */
6910
- readonly region: string;
7017
+ readonly ci?: boolean;
6911
7018
  /**
6912
- * AWS deployment type, such as dev, stage, or prod.
6913
- *
6914
- * @default 'dev'
7019
+ * `--yes` auto-confirm prompts.
6915
7020
  */
6916
- readonly awsStageType?: AwsStageType;
7021
+ readonly yes?: boolean;
6917
7022
  /**
6918
- * Deployment target role: whether this (account, region) is the primary or
6919
- * secondary deployment target (e.g. primary vs replica region).
6920
- *
6921
- * @default 'primary'
7023
+ * `--role-arn` IAM role to assume for CloudFormation deployments.
6922
7024
  */
6923
- readonly deploymentTargetRole?: DeploymentTargetRoleType;
7025
+ readonly roleArn?: string;
6924
7026
  /**
6925
- * AWS environment type, such as primary or secondary.
6926
- *
6927
- * @deprecated Use `deploymentTargetRole` instead. This property is maintained for backward compatibility.
6928
- * @default 'primary'
7027
+ * `--proxy` HTTP/HTTPS proxy URL.
6929
7028
  */
6930
- readonly awsEnvironmentType?: AwsEnvironmentType;
7029
+ readonly proxy?: string;
6931
7030
  /**
6932
- * The AWS profile to use for this deployment target.
6933
- *
6934
- * @default ['main'] when prod release type, ['feature/*'] when dev type
7031
+ * `--ca-bundle-path` path to a CA bundle for TLS verification.
6935
7032
  */
6936
- readonly branches?: Array<GitBranch>;
7033
+ readonly caBundlePath?: string;
6937
7034
  /**
6938
- * Can this deployment target be used for local development?
6939
- *
6940
- * @default true for dev environments, false for prod environments
7035
+ * `--ec2creds` force the SDK to obtain credentials from the EC2 instance
7036
+ * metadata service.
6941
7037
  */
6942
- readonly localDeployment?: boolean;
7038
+ readonly ec2creds?: boolean;
6943
7039
  /**
6944
- * Configuration when deploying to this target locally.
7040
+ * `--version-reporting` include CDK library version reporting in the
7041
+ * synthesised template metadata.
6945
7042
  */
6946
- readonly localDeploymentConfig?: AwsLocalDeploymentConfig;
7043
+ readonly versionReporting?: boolean;
6947
7044
  /**
6948
- * Can this deployment target be used in CI deployments?
6949
- *
6950
- * @default false
7045
+ * `--path-metadata` include path metadata in the synthesised template.
6951
7046
  */
6952
- readonly ciDeployment?: boolean;
6953
- readonly ciDeploymentConfig?: CiDeploymentConfig;
6954
- }
6955
- declare class AwsDeploymentTarget extends Component {
7047
+ readonly pathMetadata?: boolean;
6956
7048
  /**
6957
- * Static method to discovert targets in a project.
7049
+ * `--asset-metadata` include asset metadata in the synthesised template.
6958
7050
  */
6959
- static of(project: AwsCdkTypeScriptApp): Array<AwsDeploymentTarget> | undefined;
7051
+ readonly assetMetadata?: boolean;
6960
7052
  /**
6961
- * The account name for the deployment target.
7053
+ * `--staging` copy assets to `cdk.out` for staging.
6962
7054
  */
6963
- account: string;
7055
+ readonly staging?: boolean;
6964
7056
  /**
6965
- * The AWS region for the deployment target.
7057
+ * `--notices` show CDK notices.
6966
7058
  */
6967
- region: string;
6968
- /**'
6969
- * AWS stage type, such as dev, stage, or prod.
6970
- *
6971
- * @default 'dev'
7059
+ readonly notices?: boolean;
7060
+ /**
7061
+ * `--color` force-enable coloured output.
6972
7062
  */
6973
- awsStageType: AwsStageType;
7063
+ readonly color?: boolean;
6974
7064
  /**
6975
- * Deployment target role: whether this (account, region) is the primary or
6976
- * secondary deployment target (e.g. primary vs replica region).
6977
- *
6978
- * @default 'primary'
7065
+ * `--no-color` disable coloured output.
6979
7066
  */
6980
- deploymentTargetRole: DeploymentTargetRoleType;
7067
+ readonly noColor?: boolean;
6981
7068
  /**
6982
- * AWS environment type, such as primary or secondary.
6983
- *
6984
- * @deprecated Use `deploymentTargetRole` instead. This property is maintained for backward compatibility.
6985
- * @default 'primary'
7069
+ * `--unstable` opt into named unstable CLI features. Repeats one
7070
+ * `--unstable` flag per entry.
6986
7071
  */
6987
- awsEnvironmentType: AwsEnvironmentType;
7072
+ readonly unstable?: Array<string>;
6988
7073
  /**
6989
- * The AWS profile to use for this deployment target.
6990
- *
6991
- * @default ['main'] when prod release type, ['feature/*'] when dev type
7074
+ * `--telemetry-file` write CDK telemetry to the given path.
6992
7075
  */
6993
- branches: Array<GitBranch>;
7076
+ readonly telemetryFile?: string;
6994
7077
  /**
6995
- * Can this deployment target be used for local development?
6996
- *
6997
- * @default true for dev environments, false for prod environments
7078
+ * `--trace` print stack traces on errors.
6998
7079
  */
6999
- localDeployment?: boolean;
7080
+ readonly trace?: boolean;
7000
7081
  /**
7001
- * Configuration when deploying to this target locally.
7082
+ * `--strict` promote certain warnings to errors.
7002
7083
  */
7003
- localDeploymentConfig?: AwsLocalDeploymentConfig;
7084
+ readonly strict?: boolean;
7004
7085
  /**
7005
- * Can this deployment target be used in CI deployments?
7006
- *
7007
- * @default false
7086
+ * `--ignore-errors` proceed past non-fatal errors.
7008
7087
  */
7009
- ciDeployment?: boolean;
7010
- ciDeploymentConfig?: Required<CiDeploymentConfig>;
7088
+ readonly ignoreErrors?: boolean;
7011
7089
  /**
7012
- * Configuration for the CDK output directory for this deployment target.
7090
+ * `--json` emit JSON-formatted output.
7013
7091
  */
7014
- awsDeploymentConfig: AwsDeploymentConfig;
7015
- constructor(project: AwsCdkTypeScriptApp, options: AwsDeploymentTargetOptions);
7092
+ readonly json?: boolean;
7093
+ /**
7094
+ * `--plugin` — register one or more CDK CLI plugins. Repeats one `--plugin`
7095
+ * flag per entry.
7096
+ */
7097
+ readonly plugin?: Array<string>;
7098
+ /**
7099
+ * `--build` — command to build the CDK app before deploy.
7100
+ */
7101
+ readonly build?: string;
7016
7102
  /*****************************************************************************
7017
7103
  *
7018
- * Deploy Tasks
7019
- *
7020
- * - If local deploy, add a deploy task.
7104
+ * Trailing positional arguments
7021
7105
  *
7022
7106
  ****************************************************************************/
7023
- private configureDeployTask;
7107
+ /**
7108
+ * Stack patterns passed as trailing positional arguments. Quoted by the
7109
+ * renderer to preserve glob characters across shells.
7110
+ */
7111
+ readonly stackPatterns?: Array<string>;
7112
+ }
7113
+ /**
7114
+ * Options for the `cdk deploy` command.
7115
+ */
7116
+ interface CdkDeployOptions extends CdkGlobalOptions {
7024
7117
  /*****************************************************************************
7025
7118
  *
7026
- * Watch tasks
7027
- *
7028
- * - Configure watch task to use the branch name
7029
- * - configure watch task to use the correct synth output location.
7119
+ * Deploy-specific flags
7030
7120
  *
7031
7121
  ****************************************************************************/
7032
- private configureWatchTask;
7033
- }
7034
-
7035
- /*******************************************************************************
7036
- *
7037
- * AWS Deployment Configuration
7038
- *
7039
- * This component allows configuration of multiple AWS deployment
7040
- * targets, each with its own account, region, and deployment type
7041
- * (dev, stage, prod). It supports both local and CI deployments,
7042
- * with customizable settings for each target.
7043
- *
7044
- ******************************************************************************/
7045
- declare class AwsDeploymentConfig extends Component {
7046
- static of(project: AwsCdkTypeScriptApp): AwsDeploymentConfig | undefined;
7047
7122
  /**
7048
- * Environment variables to be injected into all tasks.
7123
+ * Deploy all stacks in the application.
7049
7124
  */
7050
- readonly env: Record<string, string>;
7125
+ readonly all?: boolean;
7051
7126
  /**
7052
- * The relative path to the project directory from the root of the project.
7127
+ * `--require-approval` when to prompt for security-related approvals.
7053
7128
  */
7054
- readonly projectPath: string;
7129
+ readonly requireApproval?: CdkRequireApproval;
7055
7130
  /**
7056
- * The relative path to the root of the project from the output directory.
7131
+ * `--rollback` / `--no-rollback` roll back the stack on failure.
7132
+ *
7133
+ * Tri-state: `true` enables rollback, `false` disables it (useful in dev for
7134
+ * fast iteration), `undefined` defers to the CLI default.
7057
7135
  */
7058
- readonly rootPath: string;
7136
+ readonly rollback?: boolean;
7059
7137
  /**
7060
- * The output directory for the CDK synthesis, from the root directory.
7138
+ * `--hotswap` apply changes directly to running resources without going
7139
+ * through CloudFormation when possible.
7140
+ *
7141
+ * @deprecated AWS recommends `--hotswap` strictly for development use; it
7142
+ * introduces drift relative to the deployed CloudFormation template and
7143
+ * should never be used in production deployments.
7061
7144
  */
7062
- readonly rootCdkOut: string;
7145
+ readonly hotswap?: boolean;
7063
7146
  /**
7064
- * The output directory for the CDK synthesis.
7147
+ * `--hotswap-fallback` fall back to a full CloudFormation deployment when a
7148
+ * hotswap is not possible.
7065
7149
  */
7066
- readonly cdkOut: string;
7150
+ readonly hotswapFallback?: boolean;
7067
7151
  /**
7068
- * Array of targets for deployment.
7152
+ * `--method` how the deployment is performed (change-set vs direct).
7069
7153
  */
7070
- readonly awsDeploymentTargets: Array<AwsDeploymentTarget>;
7071
- constructor(project: AwsCdkTypeScriptApp);
7072
- /*****************************************************************************
7073
- *
7074
- * Target filter helpers
7075
- *
7076
- * Return various targets for deployment scripts to use.
7077
- *
7078
- ****************************************************************************/
7154
+ readonly method?: CdkDeployMethod;
7079
7155
  /**
7080
- * @returns All production deployment targets.
7156
+ * `--change-set-name` name of the change set to create/execute.
7081
7157
  */
7082
- get prodTargets(): Array<AwsDeploymentTarget>;
7083
- get prodTargetsForCI(): Array<AwsDeploymentTarget>;
7084
- get prodTargetsForLocal(): Array<AwsDeploymentTarget>;
7158
+ readonly changeSetName?: string;
7085
7159
  /**
7086
- *
7087
- * @returns All stage deployment targets.
7160
+ * `--force` — always deploy even if no changes are detected.
7088
7161
  */
7089
- get stageTargets(): Array<AwsDeploymentTarget>;
7090
- get stageTargetsForCI(): Array<AwsDeploymentTarget>;
7091
- get stageTargetsForLocal(): Array<AwsDeploymentTarget>;
7162
+ readonly force?: boolean;
7163
+ /**
7164
+ * `--exclusively` — deploy only the requested stacks; do not include
7165
+ * dependencies.
7166
+ */
7167
+ readonly exclusively?: boolean;
7168
+ /**
7169
+ * `--toolkit-stack-name` — name of the CDK toolkit stack used as the
7170
+ * environment bootstrap.
7171
+ */
7172
+ readonly toolkitStackName?: string;
7173
+ /**
7174
+ * `--parameters` — CloudFormation parameters to pass to the stack. Each
7175
+ * entry is a `KEY=VALUE` string. Repeats one `--parameters` flag per entry.
7176
+ */
7177
+ readonly parameters?: Array<string>;
7178
+ /**
7179
+ * `--outputs-file` — write CloudFormation outputs to a JSON file at the
7180
+ * given path.
7181
+ */
7182
+ readonly outputsFile?: string;
7183
+ /**
7184
+ * `--previous-parameters` — use previous parameter values for any parameters
7185
+ * not explicitly supplied.
7186
+ */
7187
+ readonly previousParameters?: boolean;
7188
+ /**
7189
+ * `--concurrency` — number of stacks to deploy in parallel.
7190
+ */
7191
+ readonly concurrency?: number;
7192
+ /**
7193
+ * `--asset-parallelism` — upload assets in parallel.
7194
+ */
7195
+ readonly assetParallelism?: boolean;
7196
+ /**
7197
+ * `--asset-prebuild` — pre-build assets before deploying.
7198
+ */
7199
+ readonly assetPrebuild?: boolean;
7200
+ /**
7201
+ * `--watch` — continue watching for changes after the initial deploy.
7202
+ */
7203
+ readonly watch?: boolean;
7204
+ /**
7205
+ * `--logs` — stream CloudWatch logs for resources updated by the deploy.
7206
+ */
7207
+ readonly logs?: boolean;
7208
+ /**
7209
+ * `--build-exclude` — names of asset bundlers/build steps to skip. Repeats
7210
+ * one `--build-exclude` flag per entry.
7211
+ */
7212
+ readonly buildExclude?: Array<string>;
7213
+ /**
7214
+ * `--notification-arns` — SNS topic ARNs to notify on stack events. Repeats
7215
+ * one `--notification-arns` flag per entry.
7216
+ */
7217
+ readonly notificationArns?: Array<string>;
7092
7218
  /**
7219
+ * `--tags` — tags to apply to all stack resources. Repeats one `--tags` flag
7220
+ * per `KEY=VALUE` entry.
7093
7221
  *
7094
- * @returns All dev deployment targets.
7222
+ * @deprecated Tag declarations belong in the cloud assembly via
7223
+ * `Tags.of(scope).add(...)` rather than the CLI. The flag is modelled for
7224
+ * completeness, but consumers should prefer in-stack tagging.
7095
7225
  */
7096
- get devTargets(): Array<AwsDeploymentTarget>;
7097
- get devTargetsForCI(): Array<AwsDeploymentTarget>;
7226
+ readonly tags?: Record<string, string>;
7227
+ /**
7228
+ * `--progress` — progress reporting style.
7229
+ */
7230
+ readonly progress?: CdkProgress;
7231
+ /**
7232
+ * `--ignore-no-stacks` — succeed (with a warning) when no stacks match the
7233
+ * supplied pattern.
7234
+ */
7235
+ readonly ignoreNoStacks?: boolean;
7236
+ /**
7237
+ * `--import-existing-resources` — generate a change set that imports
7238
+ * existing AWS resources into the stack.
7239
+ */
7240
+ readonly importExistingResources?: boolean;
7241
+ /**
7242
+ * `--revert-drift` — revert any drift detected on the target stacks before
7243
+ * applying the new deployment.
7244
+ */
7245
+ readonly revertDrift?: boolean;
7246
+ /**
7247
+ * `--execute` — execute the prepared change set immediately.
7248
+ *
7249
+ * @deprecated Replaced by `--method=prepare-change-set` and
7250
+ * `--method=execute-change-set`. Surfaced here only for completeness.
7251
+ */
7252
+ readonly execute?: boolean;
7253
+ }
7254
+ /**
7255
+ * Options for the `cdk synth` command.
7256
+ */
7257
+ interface CdkSynthOptions extends CdkGlobalOptions {
7258
+ /*****************************************************************************
7259
+ *
7260
+ * Synth-specific flags
7261
+ *
7262
+ ****************************************************************************/
7263
+ /**
7264
+ * `--exclusively` — synthesize only the requested stacks; do not include
7265
+ * dependencies.
7266
+ */
7267
+ readonly exclusively?: boolean;
7268
+ /**
7269
+ * `--quiet` (`-q`) — suppress the template output on stdout.
7270
+ */
7271
+ readonly quiet?: boolean;
7272
+ /**
7273
+ * `--validation` — run additional cloud-assembly validation.
7274
+ */
7275
+ readonly validation?: boolean;
7276
+ }
7277
+ /**
7278
+ * Options for the `cdk watch` command.
7279
+ */
7280
+ interface CdkWatchOptions extends CdkGlobalOptions {
7281
+ /*****************************************************************************
7282
+ *
7283
+ * Watch-specific flags
7284
+ *
7285
+ ****************************************************************************/
7286
+ /**
7287
+ * `--build-exclude` — names of asset bundlers/build steps to skip. Repeats
7288
+ * one `--build-exclude` flag per entry.
7289
+ */
7290
+ readonly buildExclude?: Array<string>;
7291
+ /**
7292
+ * `--change-set-name` — name of the change set to create/execute.
7293
+ */
7294
+ readonly changeSetName?: string;
7295
+ /**
7296
+ * `--concurrency` — number of stacks to deploy in parallel.
7297
+ */
7298
+ readonly concurrency?: number;
7299
+ /**
7300
+ * `--exclusively` — deploy only the requested stacks; do not include
7301
+ * dependencies.
7302
+ */
7303
+ readonly exclusively?: boolean;
7304
+ /**
7305
+ * `--force` — always deploy even if no changes are detected.
7306
+ */
7307
+ readonly force?: boolean;
7308
+ /**
7309
+ * `--hotswap` — apply changes directly to running resources without going
7310
+ * through CloudFormation when possible. The CLI default for `cdk watch` is
7311
+ * `true`; supply `false` to disable.
7312
+ */
7313
+ readonly hotswap?: boolean;
7314
+ /**
7315
+ * `--hotswap-fallback` — fall back to a full CloudFormation deployment when
7316
+ * a hotswap is not possible.
7317
+ */
7318
+ readonly hotswapFallback?: boolean;
7319
+ /**
7320
+ * `--logs` — stream CloudWatch logs for resources updated by the deploy.
7321
+ */
7322
+ readonly logs?: boolean;
7323
+ /**
7324
+ * `--progress` — progress reporting style.
7325
+ */
7326
+ readonly progress?: CdkProgress;
7327
+ /**
7328
+ * `--rollback` / `--no-rollback` — roll back the stack on failure.
7329
+ *
7330
+ * Tri-state: `true` enables rollback, `false` disables it (useful in dev for
7331
+ * fast iteration), `undefined` defers to the CLI default.
7332
+ */
7333
+ readonly rollback?: boolean;
7334
+ /**
7335
+ * `--toolkit-stack-name` — name of the CDK toolkit stack used as the
7336
+ * environment bootstrap.
7337
+ */
7338
+ readonly toolkitStackName?: string;
7339
+ }
7340
+ /**
7341
+ * Options for the `cdk destroy` command.
7342
+ */
7343
+ interface CdkDestroyOptions extends CdkGlobalOptions {
7344
+ /*****************************************************************************
7345
+ *
7346
+ * Destroy-specific flags
7347
+ *
7348
+ ****************************************************************************/
7349
+ /**
7350
+ * `--all` — destroy all stacks in the application.
7351
+ */
7352
+ readonly all?: boolean;
7353
+ /**
7354
+ * `--concurrency` — number of stacks to destroy in parallel.
7355
+ */
7356
+ readonly concurrency?: number;
7357
+ /**
7358
+ * `--exclusively` — destroy only the requested stacks; do not include
7359
+ * dependencies.
7360
+ */
7361
+ readonly exclusively?: boolean;
7362
+ /**
7363
+ * `--force` — skip the confirmation prompt before destroying.
7364
+ */
7365
+ readonly force?: boolean;
7366
+ }
7367
+ /**
7368
+ * Options for the `cdk diff` command.
7369
+ */
7370
+ interface CdkDiffOptions extends CdkGlobalOptions {
7371
+ /*****************************************************************************
7372
+ *
7373
+ * Diff-specific flags
7374
+ *
7375
+ ****************************************************************************/
7376
+ /**
7377
+ * `--change-set` — use a CloudFormation change set to compute the diff.
7378
+ *
7379
+ * @deprecated Prefer the `--method` flag (e.g. `--method=change-set`).
7380
+ */
7381
+ readonly changeSet?: boolean;
7382
+ /**
7383
+ * `--context-lines` — number of context lines to print around each change.
7384
+ */
7385
+ readonly contextLines?: number;
7386
+ /**
7387
+ * `--exclusively` — diff only the requested stacks; do not include
7388
+ * dependencies.
7389
+ */
7390
+ readonly exclusively?: boolean;
7391
+ /**
7392
+ * `--fail` — fail with a non-zero exit code when differences are detected.
7393
+ */
7394
+ readonly fail?: boolean;
7395
+ /**
7396
+ * `--method` — how the diff is computed.
7397
+ */
7398
+ readonly method?: CdkDiffMethod;
7399
+ /**
7400
+ * `--processed` — compare against the processed (CDK-augmented) template
7401
+ * rather than the raw user input.
7402
+ */
7403
+ readonly processed?: boolean;
7404
+ /**
7405
+ * `--quiet` — suppress unchanged-resource output.
7406
+ */
7407
+ readonly quiet?: boolean;
7408
+ /**
7409
+ * `--security-only` — restrict the diff to security-relevant changes only.
7410
+ */
7411
+ readonly securityOnly?: boolean;
7412
+ /**
7413
+ * `--template` — diff against a specific template file path.
7414
+ */
7415
+ readonly template?: string;
7416
+ }
7417
+ /**
7418
+ * Options for the `cdk bootstrap` command.
7419
+ */
7420
+ interface CdkBootstrapOptions extends CdkGlobalOptions {
7421
+ /*****************************************************************************
7422
+ *
7423
+ * Bootstrap-specific flags
7424
+ *
7425
+ ****************************************************************************/
7426
+ /**
7427
+ * `--bootstrap-bucket-name` / `--toolkit-bucket-name` — name of the S3
7428
+ * bucket used by the bootstrap stack to stage assets.
7429
+ */
7430
+ readonly bootstrapBucketName?: string;
7431
+ /**
7432
+ * `--bootstrap-customer-key` — opt into a customer-managed KMS key for the
7433
+ * bootstrap bucket (creates the key as part of bootstrap).
7434
+ */
7435
+ readonly bootstrapCustomerKey?: boolean;
7436
+ /**
7437
+ * `--bootstrap-kms-key-id` — supply an existing KMS key ID for the
7438
+ * bootstrap bucket.
7439
+ */
7440
+ readonly bootstrapKmsKeyId?: string;
7441
+ /**
7442
+ * `--cloudformation-execution-policies` — managed-policy ARNs to attach to
7443
+ * the CloudFormation execution role. Repeats one
7444
+ * `--cloudformation-execution-policies` flag per entry.
7445
+ */
7446
+ readonly cloudformationExecutionPolicies?: Array<string>;
7447
+ /**
7448
+ * `--custom-permissions-boundary` — name of an IAM permissions boundary to
7449
+ * attach to the bootstrap roles.
7450
+ */
7451
+ readonly customPermissionsBoundary?: string;
7452
+ /**
7453
+ * `--example-permissions-boundary` — install the example permissions
7454
+ * boundary shipped with the CDK.
7455
+ */
7456
+ readonly examplePermissionsBoundary?: boolean;
7457
+ /**
7458
+ * `--execute` — execute the bootstrap change set immediately.
7459
+ */
7460
+ readonly execute?: boolean;
7461
+ /**
7462
+ * `--force` — force re-bootstrap even when the bootstrap stack is current.
7463
+ */
7464
+ readonly force?: boolean;
7465
+ /**
7466
+ * `--previous-parameters` — use previous parameter values for any parameters
7467
+ * not explicitly supplied.
7468
+ */
7469
+ readonly previousParameters?: boolean;
7470
+ /**
7471
+ * `--public-access-block-configuration` — enable S3 public access block on
7472
+ * the bootstrap bucket.
7473
+ */
7474
+ readonly publicAccessBlockConfiguration?: boolean;
7475
+ /**
7476
+ * `--qualifier` — qualifier appended to bootstrap resource names so multiple
7477
+ * bootstraps can coexist in the same account/region.
7478
+ */
7479
+ readonly qualifier?: string;
7480
+ /**
7481
+ * `--show-template` — emit the bootstrap template to stdout instead of
7482
+ * deploying it.
7483
+ */
7484
+ readonly showTemplate?: boolean;
7485
+ /**
7486
+ * `--tags` — tags to apply to the bootstrap stack. Repeats one `--tags`
7487
+ * flag per `KEY=VALUE` entry.
7488
+ */
7489
+ readonly tags?: Record<string, string>;
7490
+ /**
7491
+ * `--template` — bootstrap from a custom template file path.
7492
+ */
7493
+ readonly template?: string;
7494
+ /**
7495
+ * `--termination-protection` — enable CloudFormation termination protection
7496
+ * on the bootstrap stack.
7497
+ */
7498
+ readonly terminationProtection?: boolean;
7499
+ /**
7500
+ * `--toolkit-stack-name` — name of the CDK toolkit (bootstrap) stack.
7501
+ */
7502
+ readonly toolkitStackName?: string;
7503
+ /**
7504
+ * `--trust` — AWS account IDs trusted to deploy into this bootstrap
7505
+ * environment. Repeats one `--trust` flag per entry.
7506
+ */
7507
+ readonly trust?: Array<string>;
7508
+ /**
7509
+ * `--trust-for-lookup` — AWS account IDs trusted to perform context lookups
7510
+ * against this bootstrap environment. Repeats one `--trust-for-lookup` flag
7511
+ * per entry.
7512
+ */
7513
+ readonly trustForLookup?: Array<string>;
7514
+ }
7515
+ /**
7516
+ * Options for the `cdk list` / `cdk ls` command.
7517
+ */
7518
+ interface CdkListOptions extends CdkGlobalOptions {
7519
+ /*****************************************************************************
7520
+ *
7521
+ * List-specific flags
7522
+ *
7523
+ ****************************************************************************/
7524
+ /**
7525
+ * `--long` — include extra columns (account, region, etc.) in the listing.
7526
+ */
7527
+ readonly long?: boolean;
7528
+ /**
7529
+ * `--show-dependencies` — emit each stack's inter-stack dependencies.
7530
+ */
7531
+ readonly showDependencies?: boolean;
7532
+ }
7533
+ /**
7534
+ * Options for the `cdk rollback` command.
7535
+ */
7536
+ interface CdkRollbackOptions extends CdkGlobalOptions {
7537
+ /*****************************************************************************
7538
+ *
7539
+ * Rollback-specific flags
7540
+ *
7541
+ ****************************************************************************/
7542
+ /**
7543
+ * `--all` — roll back every stack in the application.
7544
+ */
7545
+ readonly all?: boolean;
7546
+ /**
7547
+ * `--force` — force the rollback even when CloudFormation reports the stack
7548
+ * is already in a stable state.
7549
+ */
7550
+ readonly force?: boolean;
7551
+ /**
7552
+ * `--orphan` — logical IDs of resources to orphan (skip) during rollback.
7553
+ * Repeats one `--orphan` flag per entry.
7554
+ */
7555
+ readonly orphan?: Array<string>;
7556
+ /**
7557
+ * `--toolkit-stack-name` — name of the CDK toolkit stack used as the
7558
+ * environment bootstrap.
7559
+ */
7560
+ readonly toolkitStackName?: string;
7561
+ /**
7562
+ * `--validate-bootstrap-version` — require the bootstrap stack version on
7563
+ * the target environment to match the version the CLI was built against.
7564
+ */
7565
+ readonly validateBootstrapVersion?: boolean;
7566
+ }
7567
+ /**
7568
+ * Options for the `cdk import` command.
7569
+ */
7570
+ interface CdkImportOptions extends CdkGlobalOptions {
7571
+ /*****************************************************************************
7572
+ *
7573
+ * Import-specific flags
7574
+ *
7575
+ ****************************************************************************/
7576
+ /**
7577
+ * `--change-set-name` — name of the import change set to create/execute.
7578
+ */
7579
+ readonly changeSetName?: string;
7580
+ /**
7581
+ * `--execute` — execute the prepared import change set immediately.
7582
+ */
7583
+ readonly execute?: boolean;
7584
+ /**
7585
+ * `--force` — proceed with the import even when CloudFormation warnings
7586
+ * would normally block it.
7587
+ */
7588
+ readonly force?: boolean;
7589
+ /**
7590
+ * `--record-resource-mapping` — write the resolved logical-id → physical-id
7591
+ * mapping to the given path for later reuse.
7592
+ */
7593
+ readonly recordResourceMapping?: string;
7594
+ /**
7595
+ * `--resource-mapping` — read the logical-id → physical-id mapping from the
7596
+ * given path instead of prompting interactively.
7597
+ */
7598
+ readonly resourceMapping?: string;
7599
+ /**
7600
+ * `--rollback` / `--no-rollback` — roll back the stack on failure.
7601
+ *
7602
+ * Tri-state: `true` enables rollback, `false` disables it, `undefined`
7603
+ * defers to the CLI default.
7604
+ */
7605
+ readonly rollback?: boolean;
7606
+ /**
7607
+ * `--toolkit-stack-name` — name of the CDK toolkit stack used as the
7608
+ * environment bootstrap.
7609
+ */
7610
+ readonly toolkitStackName?: string;
7611
+ }
7612
+ /**
7613
+ * Options for the `cdk gc` command.
7614
+ *
7615
+ * `cdk gc` is gated behind the global `--unstable=gc` flag. Callers MUST
7616
+ * include `"gc"` in {@link CdkGlobalOptions.unstable} (modelled on this
7617
+ * interface as the inherited `unstable` field) for the CLI to accept the
7618
+ * command; the renderer surfaces `unstable` as a regular global flag and does
7619
+ * not validate the gate itself.
7620
+ */
7621
+ interface CdkGcOptions extends CdkGlobalOptions {
7622
+ /*****************************************************************************
7623
+ *
7624
+ * GC-specific flags
7625
+ *
7626
+ ****************************************************************************/
7627
+ /**
7628
+ * `--action` — which garbage-collection action to perform.
7629
+ */
7630
+ readonly action?: CdkGcAction;
7631
+ /**
7632
+ * `--bootstrap-stack-name` — name of the bootstrap stack whose assets are
7633
+ * being garbage collected.
7634
+ */
7635
+ readonly bootstrapStackName?: string;
7636
+ /**
7637
+ * `--confirm` / `--no-confirm` — prompt before deleting tagged assets.
7638
+ */
7639
+ readonly confirm?: boolean;
7640
+ /**
7641
+ * `--created-buffer-days` — only consider assets created more than N days
7642
+ * ago for tagging.
7643
+ */
7644
+ readonly createdBufferDays?: number;
7645
+ /**
7646
+ * `--rollback-buffer-days` — keep tagged assets for at least N days before
7647
+ * deleting them so a rollback can recover them.
7648
+ */
7649
+ readonly rollbackBufferDays?: number;
7650
+ /**
7651
+ * `--type` — restrict garbage collection to a particular asset type.
7652
+ */
7653
+ readonly type?: CdkGcType;
7654
+ }
7655
+ /**
7656
+ * Options for the `cdk drift` command.
7657
+ */
7658
+ interface CdkDriftOptions extends CdkGlobalOptions {
7659
+ /*****************************************************************************
7660
+ *
7661
+ * Drift-specific flags
7662
+ *
7663
+ ****************************************************************************/
7664
+ /**
7665
+ * `--fail` — exit with a non-zero status when drift is detected.
7666
+ */
7667
+ readonly fail?: boolean;
7668
+ }
7669
+ /**
7670
+ * Options for the `cdk refactor` command.
7671
+ */
7672
+ interface CdkRefactorOptions extends CdkGlobalOptions {
7673
+ /*****************************************************************************
7674
+ *
7675
+ * Refactor-specific flags
7676
+ *
7677
+ ****************************************************************************/
7678
+ /**
7679
+ * `--additional-stack-name` — additional stack names to include in the
7680
+ * refactor scope. Repeats one `--additional-stack-name` flag per entry.
7681
+ */
7682
+ readonly additionalStackName?: Array<string>;
7683
+ /**
7684
+ * `--dry-run` — preview the refactor plan without applying it.
7685
+ */
7686
+ readonly dryRun?: boolean;
7687
+ /**
7688
+ * `--override-file` — path to a refactor override file that pins specific
7689
+ * resource moves.
7690
+ */
7691
+ readonly overrideFile?: string;
7692
+ /**
7693
+ * `--revert` — apply the inverse of the refactor (undo a previous refactor
7694
+ * plan).
7695
+ */
7696
+ readonly revert?: boolean;
7697
+ /**
7698
+ * `--force` — proceed even when the refactor planner would normally bail
7699
+ * out.
7700
+ */
7701
+ readonly force?: boolean;
7702
+ }
7703
+ /**
7704
+ * Options for the `cdk publish-assets` command.
7705
+ */
7706
+ interface CdkPublishAssetsOptions extends CdkGlobalOptions {
7707
+ /*****************************************************************************
7708
+ *
7709
+ * Publish-assets-specific flags
7710
+ *
7711
+ ****************************************************************************/
7712
+ /**
7713
+ * `--all` — publish assets for every stack in the application.
7714
+ */
7715
+ readonly all?: boolean;
7716
+ /**
7717
+ * `--exclusively` — publish only the requested stacks' assets; do not
7718
+ * include dependencies.
7719
+ */
7720
+ readonly exclusively?: boolean;
7721
+ /**
7722
+ * `--force` — re-upload assets even when the target already has them.
7723
+ */
7724
+ readonly force?: boolean;
7725
+ /**
7726
+ * `--concurrency` — number of asset uploads to run in parallel.
7727
+ */
7728
+ readonly concurrency?: number;
7729
+ }
7730
+ /**
7731
+ * Options for the `cdk orphan` command.
7732
+ *
7733
+ * `cdk orphan` takes only positional `<logicalId>` arguments — there are no
7734
+ * command-specific flags beyond the inherited globals.
7735
+ */
7736
+ interface CdkOrphanOptions extends CdkGlobalOptions {
7737
+ /*****************************************************************************
7738
+ *
7739
+ * Orphan-specific positional arguments
7740
+ *
7741
+ ****************************************************************************/
7742
+ /**
7743
+ * Logical resource IDs to orphan. Rendered as quoted, space-separated
7744
+ * positional arguments after the command name.
7745
+ */
7746
+ readonly logicalIds?: Array<string>;
7747
+ }
7748
+ /**
7749
+ * Options for the `cdk init` command.
7750
+ *
7751
+ * `cdk init` accepts a positional `<template>` argument and the
7752
+ * `--language` flag. Both are typed via the {@link CdkInitTemplate} and
7753
+ * {@link CdkInitLanguage} enums.
7754
+ */
7755
+ interface CdkInitOptions extends CdkGlobalOptions {
7756
+ /*****************************************************************************
7757
+ *
7758
+ * Init-specific positional arguments
7759
+ *
7760
+ ****************************************************************************/
7761
+ /**
7762
+ * Positional `<template>` argument — `app`, `lib`, or `sample-app`.
7763
+ * Rendered after the command name and any command-specific flags, before
7764
+ * the trailing tokens.
7765
+ */
7766
+ readonly template?: CdkInitTemplate;
7767
+ /*****************************************************************************
7768
+ *
7769
+ * Init-specific flags
7770
+ *
7771
+ ****************************************************************************/
7772
+ /**
7773
+ * `--language` — language to scaffold the new CDK project in.
7774
+ */
7775
+ readonly language?: CdkInitLanguage;
7776
+ /**
7777
+ * `--list` — print the available templates and exit instead of
7778
+ * scaffolding.
7779
+ */
7780
+ readonly list?: boolean;
7781
+ /**
7782
+ * `--generate-only` — generate the project files without performing
7783
+ * post-scaffold steps (e.g. `git init`, dependency install).
7784
+ */
7785
+ readonly generateOnly?: boolean;
7786
+ }
7787
+ /**
7788
+ * Options for the `cdk migrate` command.
7789
+ */
7790
+ interface CdkMigrateOptions extends CdkGlobalOptions {
7791
+ /*****************************************************************************
7792
+ *
7793
+ * Migrate-specific flags
7794
+ *
7795
+ ****************************************************************************/
7796
+ /**
7797
+ * `--stack-name` — name of the CDK stack created from the migrated
7798
+ * resources.
7799
+ */
7800
+ readonly stackName?: string;
7801
+ /**
7802
+ * `--language` — language to generate the migrated CDK app in. Reuses the
7803
+ * same enum as `cdk init`.
7804
+ */
7805
+ readonly language?: CdkInitLanguage;
7806
+ /**
7807
+ * `--account` — AWS account ID hosting the source resources.
7808
+ */
7809
+ readonly account?: string;
7810
+ /**
7811
+ * `--region` — AWS region hosting the source resources.
7812
+ */
7813
+ readonly region?: string;
7814
+ /**
7815
+ * `--from-path` — path to a CloudFormation template file to migrate from.
7816
+ */
7817
+ readonly fromPath?: string;
7818
+ /**
7819
+ * `--from-stack` — migrate from an existing CloudFormation stack by name.
7820
+ */
7821
+ readonly fromStack?: boolean;
7822
+ /**
7823
+ * `--from-scan` — migrate by initiating a CloudFormation resource scan.
7824
+ */
7825
+ readonly fromScan?: boolean;
7826
+ /**
7827
+ * `--output-path` — directory to write the generated CDK app into.
7828
+ */
7829
+ readonly outputPath?: string;
7830
+ /**
7831
+ * `--filter` — resource filter expressions that narrow which resources
7832
+ * are included in the migration. Repeats one `--filter` flag per entry.
7833
+ */
7834
+ readonly filter?: Array<string>;
7835
+ /**
7836
+ * `--compress` — compress the generated CDK app into a zip archive.
7837
+ */
7838
+ readonly compress?: boolean;
7839
+ }
7840
+ /**
7841
+ * Options for the `cdk context` command.
7842
+ */
7843
+ interface CdkContextOptions extends CdkGlobalOptions {
7844
+ /*****************************************************************************
7845
+ *
7846
+ * Context-specific flags
7847
+ *
7848
+ ****************************************************************************/
7849
+ /**
7850
+ * `--clear` — clear all cached context values.
7851
+ */
7852
+ readonly clear?: boolean;
7853
+ /**
7854
+ * `--force` — perform context operations without prompting.
7855
+ */
7856
+ readonly force?: boolean;
7857
+ /**
7858
+ * `--reset=KEY` — clear a single cached context value by key. The CLI's
7859
+ * `--reset` flag is value-taking (it accepts the context key to reset),
7860
+ * so this field is typed as `string | undefined` rather than as a
7861
+ * tri-state boolean.
7862
+ */
7863
+ readonly reset?: string;
7864
+ }
7865
+ /**
7866
+ * Options for the `cdk metadata` command.
7867
+ *
7868
+ * `cdk metadata` takes a single positional `<stack>` argument and has no
7869
+ * command-specific flags beyond the inherited globals.
7870
+ */
7871
+ interface CdkMetadataOptions extends CdkGlobalOptions {
7872
+ /*****************************************************************************
7873
+ *
7874
+ * Metadata-specific positional arguments
7875
+ *
7876
+ ****************************************************************************/
7877
+ /**
7878
+ * Positional `<stack>` argument naming the stack whose metadata to print.
7879
+ * Rendered after the command name and any command-specific flags, before
7880
+ * the trailing tokens.
7881
+ */
7882
+ readonly stack?: string;
7883
+ }
7884
+ /**
7885
+ * Options for the `cdk flags` command.
7886
+ */
7887
+ interface CdkFlagsOptions extends CdkGlobalOptions {
7888
+ /*****************************************************************************
7889
+ *
7890
+ * Flags-specific flags
7891
+ *
7892
+ ****************************************************************************/
7893
+ /**
7894
+ * `--value=FLAG` — print the configured value of a single feature flag.
7895
+ * The CLI's `--value` flag is value-taking, so this field is typed as
7896
+ * `string | undefined`.
7897
+ */
7898
+ readonly value?: string;
7899
+ /**
7900
+ * `--set=FLAG=VALUE` — set a feature flag to the given value. The CLI's
7901
+ * `--set` flag is value-taking, so this field is typed as
7902
+ * `string | undefined`.
7903
+ */
7904
+ readonly set?: string;
7905
+ /**
7906
+ * `--all` — include every known feature flag in the output.
7907
+ */
7908
+ readonly all?: boolean;
7909
+ /**
7910
+ * `--unconfigured` — include feature flags that have not been configured
7911
+ * yet.
7912
+ */
7913
+ readonly unconfigured?: boolean;
7914
+ /**
7915
+ * `--recommended` — set feature flags to their recommended values.
7916
+ */
7917
+ readonly recommended?: boolean;
7918
+ /**
7919
+ * `--default` — set feature flags to their default values.
7920
+ */
7921
+ readonly default?: boolean;
7922
+ /**
7923
+ * `--interactive` — prompt interactively to confirm each flag change.
7924
+ */
7925
+ readonly interactive?: boolean;
7926
+ /**
7927
+ * `--safe` — only apply changes that are safe (no resource replacement,
7928
+ * no destructive updates).
7929
+ */
7930
+ readonly safe?: boolean;
7931
+ /**
7932
+ * `--concurrency` — number of concurrent operations to run when applying
7933
+ * flag changes.
7934
+ */
7935
+ readonly concurrency?: number;
7936
+ }
7937
+ /**
7938
+ * Options for the `cdk acknowledge` (`ack`) command.
7939
+ *
7940
+ * `cdk acknowledge` takes a single positional `<id>` argument identifying
7941
+ * the notice to acknowledge. It has no command-specific flags beyond the
7942
+ * inherited globals.
7943
+ */
7944
+ interface CdkAcknowledgeOptions extends CdkGlobalOptions {
7945
+ /*****************************************************************************
7946
+ *
7947
+ * Acknowledge-specific positional arguments
7948
+ *
7949
+ ****************************************************************************/
7950
+ /**
7951
+ * Positional `<id>` argument — the notice ID to acknowledge. Rendered
7952
+ * after the command name and any command-specific flags, before the
7953
+ * trailing tokens.
7954
+ */
7955
+ readonly id?: string;
7956
+ }
7957
+ /**
7958
+ * Options for the `cdk notices` command.
7959
+ *
7960
+ * `cdk notices` has no command-specific flags beyond the inherited globals.
7961
+ * Surfaced as an empty interface so the renderer signature stays uniform
7962
+ * with the rest of the command surface.
7963
+ */
7964
+ interface CdkNoticesOptions extends CdkGlobalOptions {
7965
+ }
7966
+ /**
7967
+ * Options for the `cdk doctor` command.
7968
+ *
7969
+ * `cdk doctor` has no command-specific flags beyond the inherited globals.
7970
+ * Surfaced as an empty interface so the renderer signature stays uniform
7971
+ * with the rest of the command surface.
7972
+ */
7973
+ interface CdkDoctorOptions extends CdkGlobalOptions {
7974
+ }
7975
+ /**
7976
+ * Options for the `cdk docs` (`doc`) command.
7977
+ *
7978
+ * `cdk docs` has no command-specific flags beyond the inherited globals.
7979
+ * Surfaced as an empty interface so the renderer signature stays uniform
7980
+ * with the rest of the command surface.
7981
+ */
7982
+ interface CdkDocsOptions extends CdkGlobalOptions {
7983
+ }
7984
+ /**
7985
+ * Per-target / per-account override bundle for the `CdkCli` component.
7986
+ *
7987
+ * Used in two distinct positions in the override stack:
7988
+ *
7989
+ * - **Per-account** on `CdkCliOptions.accountOverrides[accountId]` —
7990
+ * applies to every {@link AwsDeploymentTarget} that resolves to the same
7991
+ * AWS account ID.
7992
+ * - **Per-target** on `AwsDeploymentTargetOptions.cdkOptions` — applies
7993
+ * only to that specific deployment target.
7994
+ *
7995
+ * Both layers slot into the precedence chain documented on {@link CdkCli};
7996
+ * per-target wins on collisions because it is the more specific layer.
7997
+ *
7998
+ * Every command field is optional so consumers can override one command
7999
+ * (e.g. just `deploy`) without restating the others.
8000
+ */
8001
+ interface CdkTargetOverrides {
8002
+ /**
8003
+ * Overrides applied to `cdk deploy` invocations against the matching
8004
+ * target / account.
8005
+ */
8006
+ readonly deploy?: Partial<CdkDeployOptions>;
8007
+ /**
8008
+ * Overrides applied to `cdk synth` invocations against the matching
8009
+ * target / account.
8010
+ */
8011
+ readonly synth?: Partial<CdkSynthOptions>;
8012
+ /**
8013
+ * Overrides applied to `cdk watch` invocations against the matching
8014
+ * target / account.
8015
+ */
8016
+ readonly watch?: Partial<CdkWatchOptions>;
8017
+ /**
8018
+ * Overrides applied to `cdk destroy` invocations against the matching
8019
+ * target / account.
8020
+ */
8021
+ readonly destroy?: Partial<CdkDestroyOptions>;
8022
+ /**
8023
+ * Overrides applied to `cdk diff` invocations against the matching
8024
+ * target / account.
8025
+ */
8026
+ readonly diff?: Partial<CdkDiffOptions>;
8027
+ /**
8028
+ * Overrides applied to `cdk bootstrap` invocations against the matching
8029
+ * target / account.
8030
+ */
8031
+ readonly bootstrap?: Partial<CdkBootstrapOptions>;
8032
+ }
8033
+
8034
+ /*******************************************************************************
8035
+ *
8036
+ * Git configs for this repo. This venn diagram has a great deal of overlap
8037
+ * with GitHub config options but is not a perfect circle.
8038
+ *
8039
+ ******************************************************************************/
8040
+ interface GitBranch {
8041
+ /**
8042
+ * The name of the branch pattern.
8043
+ *
8044
+ * @example "main" or "feature/*"
8045
+ */
8046
+ branch: string;
8047
+ /**
8048
+ * Description for this branch's purpose, used for generated documentation.
8049
+ */
8050
+ description?: Array<string>;
8051
+ }
8052
+
8053
+ /*******************************************************************************
8054
+ *
8055
+ * AWS Deployment Configuration
8056
+ *
8057
+ * A single deployment target that CDK applications can be deployed into.
8058
+ *
8059
+ ******************************************************************************/
8060
+ /**
8061
+ * Represents the configuration for local deployment in AWS.
8062
+ */
8063
+ interface AwsLocalDeploymentConfig {
8064
+ /**
8065
+ * The AWS profile (in ~/.aws/config) to use for local deployment.
8066
+ *
8067
+ * @default generated dynamically based role name, account and region
8068
+ */
8069
+ readonly profile?: string;
8070
+ /**
8071
+ * Named Role used to conduct local deployments.
8072
+ *
8073
+ * @default "poweruseraccess"
8074
+ */
8075
+ readonly roleName?: string;
8076
+ /**
8077
+ * The pattern used to identify stacks to deploy in CI deployments.
8078
+ *
8079
+ * @default `*-${account}-${region}`
8080
+ */
8081
+ readonly stackPattern?: string;
8082
+ }
8083
+ interface CiDeploymentConfig {
8084
+ /**
8085
+ * The OIDC IAM Role to assume for CI deployments.
8086
+ */
8087
+ readonly roleArn: string;
8088
+ /**
8089
+ * The pattern used to identify stacks to deploy in CI deployments.
8090
+ *
8091
+ * @default `*-${account}-${region}`
8092
+ */
8093
+ readonly stackPattern?: string;
8094
+ }
8095
+ /**
8096
+ * Represents a deployment target in AWS, including account and region, and
8097
+ * branches allowed to deploy to this target.
8098
+ */
8099
+ interface AwsDeploymentTargetOptions {
8100
+ /**
8101
+ * The account name for the deployment target.
8102
+ */
8103
+ readonly account: string;
8104
+ /**
8105
+ * The AWS region for the deployment target.
8106
+ */
8107
+ readonly region: string;
8108
+ /**
8109
+ * AWS deployment type, such as dev, stage, or prod.
8110
+ *
8111
+ * @default 'dev'
8112
+ */
8113
+ readonly awsStageType?: AwsStageType;
8114
+ /**
8115
+ * Deployment target role: whether this (account, region) is the primary or
8116
+ * secondary deployment target (e.g. primary vs replica region).
8117
+ *
8118
+ * @default 'primary'
8119
+ */
8120
+ readonly deploymentTargetRole?: DeploymentTargetRoleType;
8121
+ /**
8122
+ * AWS environment type, such as primary or secondary.
8123
+ *
8124
+ * @deprecated Use `deploymentTargetRole` instead. This property is maintained for backward compatibility.
8125
+ * @default 'primary'
8126
+ */
8127
+ readonly awsEnvironmentType?: AwsEnvironmentType;
8128
+ /**
8129
+ * The AWS profile to use for this deployment target.
8130
+ *
8131
+ * @default ['main'] when prod release type, ['feature/*'] when dev type
8132
+ */
8133
+ readonly branches?: Array<GitBranch>;
8134
+ /**
8135
+ * Can this deployment target be used for local development?
8136
+ *
8137
+ * @default true for dev environments, false for prod environments
8138
+ */
8139
+ readonly localDeployment?: boolean;
8140
+ /**
8141
+ * Configuration when deploying to this target locally.
8142
+ */
8143
+ readonly localDeploymentConfig?: AwsLocalDeploymentConfig;
8144
+ /**
8145
+ * Can this deployment target be used in CI deployments?
8146
+ *
8147
+ * @default false
8148
+ */
8149
+ readonly ciDeployment?: boolean;
8150
+ readonly ciDeploymentConfig?: CiDeploymentConfig;
8151
+ /**
8152
+ * Per-target overrides for `cdk` CLI options.
8153
+ *
8154
+ * Layered on top of the per-stage defaults and any per-account overrides
8155
+ * configured on {@link CdkCli}. See {@link CdkCli} for the full precedence
8156
+ * chain.
8157
+ */
8158
+ readonly cdkOptions?: CdkTargetOverrides;
8159
+ }
8160
+ declare class AwsDeploymentTarget extends Component {
8161
+ /**
8162
+ * Static method to discovert targets in a project.
8163
+ */
8164
+ static of(project: AwsCdkTypeScriptApp): Array<AwsDeploymentTarget> | undefined;
8165
+ /**
8166
+ * The account name for the deployment target.
8167
+ */
8168
+ account: string;
8169
+ /**
8170
+ * The AWS region for the deployment target.
8171
+ */
8172
+ region: string;
8173
+ /**'
8174
+ * AWS stage type, such as dev, stage, or prod.
8175
+ *
8176
+ * @default 'dev'
8177
+ */
8178
+ awsStageType: AwsStageType;
8179
+ /**
8180
+ * Deployment target role: whether this (account, region) is the primary or
8181
+ * secondary deployment target (e.g. primary vs replica region).
8182
+ *
8183
+ * @default 'primary'
8184
+ */
8185
+ deploymentTargetRole: DeploymentTargetRoleType;
8186
+ /**
8187
+ * AWS environment type, such as primary or secondary.
8188
+ *
8189
+ * @deprecated Use `deploymentTargetRole` instead. This property is maintained for backward compatibility.
8190
+ * @default 'primary'
8191
+ */
8192
+ awsEnvironmentType: AwsEnvironmentType;
8193
+ /**
8194
+ * The AWS profile to use for this deployment target.
8195
+ *
8196
+ * @default ['main'] when prod release type, ['feature/*'] when dev type
8197
+ */
8198
+ branches: Array<GitBranch>;
8199
+ /**
8200
+ * Can this deployment target be used for local development?
8201
+ *
8202
+ * @default true for dev environments, false for prod environments
8203
+ */
8204
+ localDeployment?: boolean;
8205
+ /**
8206
+ * Configuration when deploying to this target locally.
8207
+ */
8208
+ localDeploymentConfig?: AwsLocalDeploymentConfig;
8209
+ /**
8210
+ * Can this deployment target be used in CI deployments?
8211
+ *
8212
+ * @default false
8213
+ */
8214
+ ciDeployment?: boolean;
8215
+ ciDeploymentConfig?: Required<CiDeploymentConfig>;
8216
+ /**
8217
+ * Configuration for the CDK output directory for this deployment target.
8218
+ */
8219
+ awsDeploymentConfig: AwsDeploymentConfig;
8220
+ /**
8221
+ * Per-target overrides for `cdk` CLI options.
8222
+ *
8223
+ * Read by `CdkCli.*OptionsFor(target)` as the second-highest layer in the
8224
+ * precedence chain (below call-site explicit options, above per-account
8225
+ * overrides). See {@link CdkCli} for the full chain.
8226
+ */
8227
+ cdkOptions?: CdkTargetOverrides;
8228
+ constructor(project: AwsCdkTypeScriptApp, options: AwsDeploymentTargetOptions);
8229
+ /*****************************************************************************
8230
+ *
8231
+ * Deploy Tasks
8232
+ *
8233
+ * - If local deploy, add a deploy task.
8234
+ *
8235
+ ****************************************************************************/
8236
+ private configureDeployTask;
8237
+ /*****************************************************************************
8238
+ *
8239
+ * Watch tasks
8240
+ *
8241
+ * - Configure watch task to use the branch name
8242
+ * - configure watch task to use the correct synth output location.
8243
+ *
8244
+ ****************************************************************************/
8245
+ private configureWatchTask;
8246
+ }
8247
+
8248
+ /*******************************************************************************
8249
+ *
8250
+ * AWS CDK CLI Component
8251
+ *
8252
+ * Owns the per-project options that get layered into every `cdk` CLI
8253
+ * invocation the generated project makes. Phase 1 covered `cdk deploy`; Phase
8254
+ * 2 extended the component with `synth`, `watch`, `destroy`, `diff`, and
8255
+ * `bootstrap`. Phase 5 (this revision) wires in the full per-target /
8256
+ * per-account override surface and the generic {@link mergeCdkOptions} folder.
8257
+ *
8258
+ * ## Override precedence
8259
+ *
8260
+ * Each `*OptionsFor(target)` accessor folds the layers below in
8261
+ * **lowest-precedence-first** order; the rightmost (highest) layer wins on
8262
+ * scalar collisions, arrays concat-and-dedupe across layers, and record-valued
8263
+ * fields merge one level deep with the higher layer winning on key collisions.
8264
+ *
8265
+ * 1. **Per-stage built-in default** — from `CDK_*_DEFAULTS_BY_STAGE` for the
8266
+ * target's {@link AwsDeploymentTarget.awsStageType}.
8267
+ * 2. **Per-stage consumer override** — from this component's
8268
+ * `<command>Defaults[stage]` map.
8269
+ * 3. **Per-account override** — from `accountOverrides[target.account][<command>]`.
8270
+ * 4. **Per-target override** — from `target.cdkOptions.<command>`.
8271
+ * 5. **Call-site explicit option** — passed by the caller into the renderer
8272
+ * directly, after the accessor returns. The accessor does not see this
8273
+ * layer; the caller is responsible for spreading the accessor result first
8274
+ * and then the call-site option on top.
8275
+ *
8276
+ * Auto-instantiated by {@link AwsDeploymentConfig} when absent; consumers can
8277
+ * pre-instantiate it via `new CdkCli(project, options)` to register custom
8278
+ * per-stage defaults and per-account overrides.
8279
+ *
8280
+ ******************************************************************************/
8281
+ /**
8282
+ * Options accepted by {@link CdkCli}.
8283
+ */
8284
+ interface CdkCliOptions {
8285
+ /**
8286
+ * Consumer-supplied overrides for the built-in per-stage deploy defaults.
8287
+ *
8288
+ * Each entry is merged on top of
8289
+ * {@link CDK_DEPLOY_DEFAULTS_BY_STAGE} for the matching stage via
8290
+ * {@link mergeCdkOptions}.
8291
+ */
8292
+ readonly deployDefaults?: Partial<Record<AwsStageType, Partial<CdkDeployOptions>>>;
8293
+ /**
8294
+ * Consumer-supplied overrides for the built-in per-stage synth defaults.
8295
+ *
8296
+ * Each entry is merged on top of
8297
+ * {@link CDK_SYNTH_DEFAULTS_BY_STAGE} for the matching stage via
8298
+ * {@link mergeCdkOptions}.
8299
+ */
8300
+ readonly synthDefaults?: Partial<Record<AwsStageType, Partial<CdkSynthOptions>>>;
8301
+ /**
8302
+ * Consumer-supplied overrides for the built-in per-stage watch defaults.
8303
+ *
8304
+ * Each entry is merged on top of
8305
+ * {@link CDK_WATCH_DEFAULTS_BY_STAGE} for the matching stage via
8306
+ * {@link mergeCdkOptions}.
8307
+ */
8308
+ readonly watchDefaults?: Partial<Record<AwsStageType, Partial<CdkWatchOptions>>>;
8309
+ /**
8310
+ * Consumer-supplied overrides for the built-in per-stage destroy defaults.
8311
+ *
8312
+ * Each entry is merged on top of
8313
+ * {@link CDK_DESTROY_DEFAULTS_BY_STAGE} for the matching stage via
8314
+ * {@link mergeCdkOptions}.
8315
+ */
8316
+ readonly destroyDefaults?: Partial<Record<AwsStageType, Partial<CdkDestroyOptions>>>;
8317
+ /**
8318
+ * Consumer-supplied overrides for the built-in per-stage diff defaults.
8319
+ *
8320
+ * Each entry is merged on top of
8321
+ * {@link CDK_DIFF_DEFAULTS_BY_STAGE} for the matching stage via
8322
+ * {@link mergeCdkOptions}.
8323
+ */
8324
+ readonly diffDefaults?: Partial<Record<AwsStageType, Partial<CdkDiffOptions>>>;
8325
+ /**
8326
+ * Consumer-supplied overrides for the built-in per-stage bootstrap defaults.
8327
+ *
8328
+ * Each entry is merged on top of
8329
+ * {@link CDK_BOOTSTRAP_DEFAULTS_BY_STAGE} for the matching stage via
8330
+ * {@link mergeCdkOptions}.
8331
+ */
8332
+ readonly bootstrapDefaults?: Partial<Record<AwsStageType, Partial<CdkBootstrapOptions>>>;
8333
+ /**
8334
+ * Per-account overrides keyed by AWS account ID.
8335
+ *
8336
+ * Each value is a {@link CdkTargetOverrides} bundle that applies to every
8337
+ * {@link AwsDeploymentTarget} whose `account` matches the key. Sits in the
8338
+ * precedence chain between per-stage overrides and per-target overrides —
8339
+ * see {@link CdkCli} for the full layer order.
8340
+ *
8341
+ * Example: pin `--no-rollback` on every deploy into a sandbox account
8342
+ * regardless of the target's stage:
8343
+ *
8344
+ * ```typescript
8345
+ * new CdkCli(project, {
8346
+ * accountOverrides: {
8347
+ * "111122223333": { deploy: { rollback: false } },
8348
+ * },
8349
+ * });
8350
+ * ```
8351
+ */
8352
+ readonly accountOverrides?: Record<string, CdkTargetOverrides>;
8353
+ }
8354
+ declare class CdkCli extends Component {
8355
+ /**
8356
+ * Find the {@link CdkCli} component already attached to the project, if any.
8357
+ */
8358
+ static of(project: AwsCdkTypeScriptApp): CdkCli | undefined;
8359
+ /**
8360
+ * The consumer-supplied per-stage deploy default overrides.
8361
+ */
8362
+ readonly deployDefaults: Partial<Record<AwsStageType, Partial<CdkDeployOptions>>>;
8363
+ /**
8364
+ * The consumer-supplied per-stage synth default overrides.
8365
+ */
8366
+ readonly synthDefaults: Partial<Record<AwsStageType, Partial<CdkSynthOptions>>>;
8367
+ /**
8368
+ * The consumer-supplied per-stage watch default overrides.
8369
+ */
8370
+ readonly watchDefaults: Partial<Record<AwsStageType, Partial<CdkWatchOptions>>>;
8371
+ /**
8372
+ * The consumer-supplied per-stage destroy default overrides.
8373
+ */
8374
+ readonly destroyDefaults: Partial<Record<AwsStageType, Partial<CdkDestroyOptions>>>;
8375
+ /**
8376
+ * The consumer-supplied per-stage diff default overrides.
8377
+ */
8378
+ readonly diffDefaults: Partial<Record<AwsStageType, Partial<CdkDiffOptions>>>;
8379
+ /**
8380
+ * The consumer-supplied per-stage bootstrap default overrides.
8381
+ */
8382
+ readonly bootstrapDefaults: Partial<Record<AwsStageType, Partial<CdkBootstrapOptions>>>;
8383
+ /**
8384
+ * The consumer-supplied per-account overrides, keyed by AWS account ID.
8385
+ */
8386
+ readonly accountOverrides: Record<string, CdkTargetOverrides>;
8387
+ constructor(project: AwsCdkTypeScriptApp, options?: CdkCliOptions);
8388
+ /**
8389
+ * Resolve the `cdk deploy` options to use against a given target.
8390
+ *
8391
+ * Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
8392
+ * → per-stage consumer override → per-account override → per-target
8393
+ * override. The call-site explicit layer is applied by the caller after
8394
+ * this method returns. See {@link CdkCli} for the full chain.
8395
+ */
8396
+ deployOptionsFor(target: AwsDeploymentTarget): CdkDeployOptions;
8397
+ /**
8398
+ * Resolve the `cdk synth` options to use against a given target.
8399
+ *
8400
+ * Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
8401
+ * → per-stage consumer override → per-account override → per-target
8402
+ * override. See {@link CdkCli} for the full chain.
8403
+ */
8404
+ synthOptionsFor(target: AwsDeploymentTarget): CdkSynthOptions;
8405
+ /**
8406
+ * Resolve the `cdk watch` options to use against a given target.
8407
+ *
8408
+ * Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
8409
+ * → per-stage consumer override → per-account override → per-target
8410
+ * override. See {@link CdkCli} for the full chain.
8411
+ */
8412
+ watchOptionsFor(target: AwsDeploymentTarget): CdkWatchOptions;
8413
+ /**
8414
+ * Resolve the `cdk destroy` options to use against a given target.
8415
+ *
8416
+ * Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
8417
+ * → per-stage consumer override → per-account override → per-target
8418
+ * override. See {@link CdkCli} for the full chain.
8419
+ */
8420
+ destroyOptionsFor(target: AwsDeploymentTarget): CdkDestroyOptions;
8421
+ /**
8422
+ * Resolve the `cdk diff` options to use against a given target.
8423
+ *
8424
+ * Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
8425
+ * → per-stage consumer override → per-account override → per-target
8426
+ * override. See {@link CdkCli} for the full chain.
8427
+ */
8428
+ diffOptionsFor(target: AwsDeploymentTarget): CdkDiffOptions;
8429
+ /**
8430
+ * Resolve the `cdk bootstrap` options to use against a given target.
8431
+ *
8432
+ * Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
8433
+ * → per-stage consumer override → per-account override → per-target
8434
+ * override. See {@link CdkCli} for the full chain.
8435
+ */
8436
+ bootstrapOptionsFor(target: AwsDeploymentTarget): CdkBootstrapOptions;
8437
+ }
8438
+
8439
+ /*******************************************************************************
8440
+ *
8441
+ * AWS Deployment Configuration
8442
+ *
8443
+ * This component allows configuration of multiple AWS deployment
8444
+ * targets, each with its own account, region, and deployment type
8445
+ * (dev, stage, prod). It supports both local and CI deployments,
8446
+ * with customizable settings for each target.
8447
+ *
8448
+ ******************************************************************************/
8449
+ declare class AwsDeploymentConfig extends Component {
8450
+ static of(project: AwsCdkTypeScriptApp): AwsDeploymentConfig | undefined;
8451
+ /**
8452
+ * Environment variables to be injected into all tasks.
8453
+ */
8454
+ readonly env: Record<string, string>;
8455
+ /**
8456
+ * The relative path to the project directory from the root of the project.
8457
+ */
8458
+ readonly projectPath: string;
8459
+ /**
8460
+ * The relative path to the root of the project from the output directory.
8461
+ */
8462
+ readonly rootPath: string;
8463
+ /**
8464
+ * The output directory for the CDK synthesis, from the root directory.
8465
+ */
8466
+ readonly rootCdkOut: string;
8467
+ /**
8468
+ * The output directory for the CDK synthesis.
8469
+ */
8470
+ readonly cdkOut: string;
8471
+ /**
8472
+ * Array of targets for deployment.
8473
+ */
8474
+ readonly awsDeploymentTargets: Array<AwsDeploymentTarget>;
8475
+ /**
8476
+ * The CDK CLI component that owns shared `cdk` invocation options for this
8477
+ * project.
8478
+ */
8479
+ readonly cdkCli: CdkCli;
8480
+ constructor(project: AwsCdkTypeScriptApp);
8481
+ /*****************************************************************************
8482
+ *
8483
+ * Target filter helpers
8484
+ *
8485
+ * Return various targets for deployment scripts to use.
8486
+ *
8487
+ ****************************************************************************/
8488
+ /**
8489
+ * @returns All production deployment targets.
8490
+ */
8491
+ get prodTargets(): Array<AwsDeploymentTarget>;
8492
+ get prodTargetsForCI(): Array<AwsDeploymentTarget>;
8493
+ get prodTargetsForLocal(): Array<AwsDeploymentTarget>;
8494
+ /**
8495
+ *
8496
+ * @returns All stage deployment targets.
8497
+ */
8498
+ get stageTargets(): Array<AwsDeploymentTarget>;
8499
+ get stageTargetsForCI(): Array<AwsDeploymentTarget>;
8500
+ get stageTargetsForLocal(): Array<AwsDeploymentTarget>;
8501
+ /**
8502
+ *
8503
+ * @returns All dev deployment targets.
8504
+ */
8505
+ get devTargets(): Array<AwsDeploymentTarget>;
8506
+ get devTargetsForCI(): Array<AwsDeploymentTarget>;
7098
8507
  get devTargetsForLocal(): Array<AwsDeploymentTarget>;
7099
8508
  /*****************************************************************************
7100
8509
  *
@@ -7172,6 +8581,226 @@ interface AwsOrganization {
7172
8581
  accounts: Array<AwsAccount>;
7173
8582
  }
7174
8583
 
8584
+ /*******************************************************************************
8585
+ *
8586
+ * AWS CDK CLI Defaults
8587
+ *
8588
+ * Per-stage default option sets the `CdkCli` component layers in when a
8589
+ * consumer asks for the options to use against a given deployment target.
8590
+ * Phase 1 registered defaults for `cdk deploy`; Phase 2 registers defaults for
8591
+ * `synth`, `watch`, `destroy`, `diff`, and `bootstrap`.
8592
+ *
8593
+ ******************************************************************************/
8594
+ /**
8595
+ * Per-stage defaults for `cdk deploy`.
8596
+ *
8597
+ * - `dev` opts into `--no-rollback` for fast iteration.
8598
+ * - `stage` and `prod` deliberately omit `rollback` so the CLI default
8599
+ * (`true`, i.e. atomic deploys with rollback) applies — this is what allows
8600
+ * replacement-style updates to succeed in stage/prod.
8601
+ * - `prod` pins `--method=change-set` to leave a reviewable change-set trail.
8602
+ */
8603
+ declare const CDK_DEPLOY_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkDeployOptions>>;
8604
+ /**
8605
+ * Per-stage defaults for `cdk synth`.
8606
+ *
8607
+ * Every stage runs synth with `--quiet` so the synthesised template stays out
8608
+ * of normal task logs.
8609
+ */
8610
+ declare const CDK_SYNTH_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkSynthOptions>>;
8611
+ /**
8612
+ * Per-stage defaults for `cdk watch`.
8613
+ *
8614
+ * Every stage uses `--progress=events` to stream CloudFormation events line by
8615
+ * line. The CLI default for `cdk watch --hotswap` is already `true`, so the
8616
+ * record leaves it unset.
8617
+ */
8618
+ declare const CDK_WATCH_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkWatchOptions>>;
8619
+ /**
8620
+ * Per-stage defaults for `cdk destroy`.
8621
+ *
8622
+ * `dev` opts into `--force` so local teardown does not prompt; `stage` and
8623
+ * `prod` deliberately omit `force` so the CLI's confirmation prompt fires.
8624
+ */
8625
+ declare const CDK_DESTROY_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkDestroyOptions>>;
8626
+ /**
8627
+ * Per-stage defaults for `cdk diff`.
8628
+ *
8629
+ * Empty by default — diff has no flags whose stage-by-stage value is obvious.
8630
+ * Reserved for consumer overrides.
8631
+ */
8632
+ declare const CDK_DIFF_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkDiffOptions>>;
8633
+ /**
8634
+ * Per-stage defaults for `cdk bootstrap`.
8635
+ *
8636
+ * `prod` opts into `--termination-protection` so the bootstrap stack cannot be
8637
+ * accidentally deleted; `dev` and `stage` omit it.
8638
+ */
8639
+ declare const CDK_BOOTSTRAP_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkBootstrapOptions>>;
8640
+
8641
+ /*******************************************************************************
8642
+ *
8643
+ * AWS CDK CLI Option Merge
8644
+ *
8645
+ * Generic helper that folds a precedence-ordered list of `CdkXxxOptions`
8646
+ * fragments into a single resolved option set. Used by every
8647
+ * `CdkCli.*OptionsFor(target)` accessor to assemble the documented 5-level
8648
+ * override stack (per-stage default → per-account override → per-target
8649
+ * override → consumer override → call-site explicit) without per-command merge
8650
+ * logic.
8651
+ *
8652
+ * Merge semantics (see also the `CdkCli` JSDoc):
8653
+ *
8654
+ * - **Scalars** (booleans, strings, numbers, enums): a non-`undefined` value in
8655
+ * a later (higher-precedence) layer overwrites the previous value. An
8656
+ * `undefined` value in a later layer is treated as "no opinion" and falls
8657
+ * through to whatever lower layers contributed.
8658
+ * - **Arrays**: concatenated low → high precedence, then deduplicated preserving
8659
+ * document order (first occurrence wins). This lets a per-stage default seed
8660
+ * a list and per-target/per-account layers append to it without losing the
8661
+ * seeded entries.
8662
+ * - **Records / maps** (plain object values, including `tags` and `context`
8663
+ * when modelled as `Record<string, string>`): merged one level deep; later
8664
+ * layers win on key collisions, earlier layers' keys survive otherwise.
8665
+ * - **`undefined` layers** and **`undefined` field values** short-circuit — no
8666
+ * field on the output is touched by a missing layer or a `undefined` entry.
8667
+ *
8668
+ ******************************************************************************/
8669
+ /**
8670
+ * Fold a precedence-ordered list of partial CDK CLI option layers into a
8671
+ * single resolved option set.
8672
+ *
8673
+ * Layers are supplied in **lowest-precedence-first** order. Each subsequent
8674
+ * layer's non-`undefined` values overwrite the previous accumulator for
8675
+ * scalars; arrays are concatenated and deduped; record-valued fields are
8676
+ * merged one level deep.
8677
+ *
8678
+ * `undefined` layers are skipped entirely. `undefined` field values within a
8679
+ * layer are skipped per-field — they never clobber a previously set value.
8680
+ *
8681
+ * @typeParam TOptions - The fully resolved option interface (e.g.
8682
+ * `CdkDeployOptions`). The function returns `TOptions`, but the caller is
8683
+ * responsible for ensuring every field its consumers depend on is supplied
8684
+ * by at least one layer — the helper does not validate completeness.
8685
+ */
8686
+ declare const mergeCdkOptions: <TOptions>(...layers: Array<Partial<TOptions> | undefined>) => TOptions;
8687
+
8688
+ /**
8689
+ * Render a `cdk deploy ...` command from the supplied options. Returns the
8690
+ * full command string (starting with `deploy`).
8691
+ */
8692
+ declare const renderCdkDeploy: (opts: CdkDeployOptions) => string;
8693
+ /**
8694
+ * Render a `cdk synth ...` command from the supplied options.
8695
+ */
8696
+ declare const renderCdkSynth: (opts: CdkSynthOptions) => string;
8697
+ /**
8698
+ * Render a `cdk watch ...` command from the supplied options.
8699
+ */
8700
+ declare const renderCdkWatch: (opts: CdkWatchOptions) => string;
8701
+ /**
8702
+ * Render a `cdk destroy ...` command from the supplied options.
8703
+ */
8704
+ declare const renderCdkDestroy: (opts: CdkDestroyOptions) => string;
8705
+ /**
8706
+ * Render a `cdk diff ...` command from the supplied options.
8707
+ */
8708
+ declare const renderCdkDiff: (opts: CdkDiffOptions) => string;
8709
+ /**
8710
+ * Render a `cdk bootstrap ...` command from the supplied options.
8711
+ */
8712
+ declare const renderCdkBootstrap: (opts: CdkBootstrapOptions) => string;
8713
+ /**
8714
+ * Render a `cdk list ...` command from the supplied options.
8715
+ */
8716
+ declare const renderCdkList: (opts: CdkListOptions) => string;
8717
+ /**
8718
+ * Render a `cdk rollback ...` command from the supplied options.
8719
+ */
8720
+ declare const renderCdkRollback: (opts: CdkRollbackOptions) => string;
8721
+ /**
8722
+ * Render a `cdk import ...` command from the supplied options.
8723
+ */
8724
+ declare const renderCdkImport: (opts: CdkImportOptions) => string;
8725
+ /**
8726
+ * Render a `cdk gc ...` command from the supplied options.
8727
+ *
8728
+ * The CLI requires the global `--unstable=gc` flag for this command; callers
8729
+ * are responsible for including `"gc"` in {@link CdkGlobalOptions.unstable}.
8730
+ */
8731
+ declare const renderCdkGc: (opts: CdkGcOptions) => string;
8732
+ /**
8733
+ * Render a `cdk drift ...` command from the supplied options.
8734
+ */
8735
+ declare const renderCdkDrift: (opts: CdkDriftOptions) => string;
8736
+ /**
8737
+ * Render a `cdk refactor ...` command from the supplied options.
8738
+ */
8739
+ declare const renderCdkRefactor: (opts: CdkRefactorOptions) => string;
8740
+ /**
8741
+ * Render a `cdk publish-assets ...` command from the supplied options.
8742
+ */
8743
+ declare const renderCdkPublishAssets: (opts: CdkPublishAssetsOptions) => string;
8744
+ /**
8745
+ * Render a `cdk orphan ...` command from the supplied options. Positional
8746
+ * `logicalIds` render after the command name as quoted, space-separated
8747
+ * arguments.
8748
+ */
8749
+ declare const renderCdkOrphan: (opts: CdkOrphanOptions) => string;
8750
+ /**
8751
+ * Render a `cdk init ...` command from the supplied options. The positional
8752
+ * `template` argument renders after the command-specific flags, before the
8753
+ * trailing tokens.
8754
+ */
8755
+ declare const renderCdkInit: (opts: CdkInitOptions) => string;
8756
+ /**
8757
+ * Render a `cdk migrate ...` command from the supplied options.
8758
+ */
8759
+ declare const renderCdkMigrate: (opts: CdkMigrateOptions) => string;
8760
+ /**
8761
+ * Render a `cdk context ...` command from the supplied options. The CLI's
8762
+ * `--reset` flag takes a context key as its value, so `reset` is rendered
8763
+ * as `--reset=KEY` rather than as a tri-state boolean.
8764
+ */
8765
+ declare const renderCdkContext: (opts: CdkContextOptions) => string;
8766
+ /**
8767
+ * Render a `cdk metadata ...` command from the supplied options. The
8768
+ * positional `stack` argument renders after the command-specific flags
8769
+ * (there are none beyond the inherited globals), before the trailing
8770
+ * tokens.
8771
+ */
8772
+ declare const renderCdkMetadata: (opts: CdkMetadataOptions) => string;
8773
+ /**
8774
+ * Render a `cdk flags ...` command from the supplied options. `--value` and
8775
+ * `--set` are value-taking string flags per the CLI surface; the remaining
8776
+ * flags are tri-state booleans.
8777
+ */
8778
+ declare const renderCdkFlags: (opts: CdkFlagsOptions) => string;
8779
+ /**
8780
+ * Render a `cdk acknowledge ...` command from the supplied options. The
8781
+ * positional `id` argument renders after the command-specific flags (there
8782
+ * are none beyond the inherited globals), before the trailing tokens.
8783
+ */
8784
+ declare const renderCdkAcknowledge: (opts: CdkAcknowledgeOptions) => string;
8785
+ /**
8786
+ * Render a `cdk notices ...` command from the supplied options. `notices`
8787
+ * has no command-specific flags; only the inherited globals and trailing
8788
+ * tokens contribute output.
8789
+ */
8790
+ declare const renderCdkNotices: (opts: CdkNoticesOptions) => string;
8791
+ /**
8792
+ * Render a `cdk doctor ...` command from the supplied options. `doctor` has
8793
+ * no command-specific flags; only the inherited globals and trailing tokens
8794
+ * contribute output.
8795
+ */
8796
+ declare const renderCdkDoctor: (opts: CdkDoctorOptions) => string;
8797
+ /**
8798
+ * Render a `cdk docs ...` command from the supplied options. `docs` has no
8799
+ * command-specific flags; only the inherited globals and trailing tokens
8800
+ * contribute output.
8801
+ */
8802
+ declare const renderCdkDocs: (opts: CdkDocsOptions) => string;
8803
+
7175
8804
  /**
7176
8805
  * One row in the doc reference-extraction report — describes a single
7177
8806
  * inline-code symbol mention found in a markdown page and whether
@@ -7541,7 +9170,7 @@ declare const AuditCategory: {
7541
9170
  readonly LinkFailures: "linkFailures";
7542
9171
  /**
7543
9172
  * Findings produced by the fenced-sample compilation check that
7544
- * flags ` ```ts ` / ` ```typescript ` / ` ```tsx ` blocks in the
9173
+ * flags `ts`, `typescript`, and `tsx` fenced code blocks in the
7545
9174
  * docs that fail `tsc`. Wired in by child issue #520.
7546
9175
  */
7547
9176
  readonly SampleFailures: "sampleFailures";
@@ -8467,7 +10096,7 @@ declare const VERSION: {
8467
10096
  */
8468
10097
  readonly SHARP_VERSION: "0.34.5";
8469
10098
  /**
8470
- * Version of @astrojs/starlight to pin for StarlightProject scaffolding.
10099
+ * Version of `@astrojs/starlight` to pin for StarlightProject scaffolding.
8471
10100
  */
8472
10101
  readonly STARLIGHT_VERSION: "0.39.2";
8473
10102
  /**
@@ -8475,7 +10104,7 @@ declare const VERSION: {
8475
10104
  */
8476
10105
  readonly TURBO_VERSION: "2.9.14";
8477
10106
  /**
8478
- * Version of @types/node to use across all packages (pnpm catalog).
10107
+ * Version of `@types/node` to use across all packages (pnpm catalog).
8479
10108
  */
8480
10109
  readonly TYPES_NODE_VERSION: "25.8.0";
8481
10110
  /**
@@ -8839,8 +10468,8 @@ declare class PnpmWorkspace extends Component {
8839
10468
  * Get the pnpm workspace component of a project. If it does not exist,
8840
10469
  * return undefined.
8841
10470
  *
8842
- * @param project
8843
- * @returns
10471
+ * @param project - The project to query.
10472
+ * @returns The PnpmWorkspace component if present, otherwise undefined.
8844
10473
  */
8845
10474
  static of(project: Project): PnpmWorkspace | undefined;
8846
10475
  /**
@@ -9206,7 +10835,7 @@ interface VitestConfigOptions {
9206
10835
  /**
9207
10836
  * Glob patterns for test files.
9208
10837
  *
9209
- * @default ["**\/*.{test,spec}.?(c|m)[jt]s?(x)"]
10838
+ * @default `["**\/*.{test,spec}.?(c|m)[jt]s?(x)"]`
9210
10839
  */
9211
10840
  readonly include?: string[];
9212
10841
  /**
@@ -9348,7 +10977,7 @@ interface TypeScriptProjectOptions extends Omit<typescript.TypeScriptProjectOpti
9348
10977
  * `.api-extractor/` and are gitignored). Set to `false` to opt a
9349
10978
  * package out of drift detection entirely.
9350
10979
  *
9351
- * @default {}
10980
+ * @default `{}`
9352
10981
  */
9353
10982
  readonly apiExtractor?: ApiExtractorOptions | false;
9354
10983
  /**
@@ -9367,7 +10996,7 @@ interface TypeScriptProjectOptions extends Omit<typescript.TypeScriptProjectOpti
9367
10996
  * `internal` tag — even when the token sits inside a backtick code span
9368
10997
  * — and that strips this field from the published `.d.ts` rollup.
9369
10998
  *
9370
- * @default {}
10999
+ * @default `{}`
9371
11000
  */
9372
11001
  readonly tsdocConfig?: TsdocConfigOptions | false;
9373
11002
  /**
@@ -9509,7 +11138,7 @@ declare class AwsDeployWorkflow extends Component {
9509
11138
  * Handles both exact matches (e.g., "main") and glob patterns (e.g., "feature/*").
9510
11139
  * Also allows workflow_dispatch (manual runs) to proceed.
9511
11140
  *
9512
- * @param branches Array of GitBranch objects with branch patterns
11141
+ * @param branches - Array of GitBranch objects with branch patterns
9513
11142
  * @returns Condition string or empty string if no branches provided
9514
11143
  */
9515
11144
  private buildBranchFilterCondition;
@@ -9716,7 +11345,7 @@ interface TurboRepoOptions {
9716
11345
  /**
9717
11346
  * Version of turborepo to use.
9718
11347
  *
9719
- * @default: specified in versions file
11348
+ * @default specified in versions file
9720
11349
  */
9721
11350
  readonly turboVersion?: string;
9722
11351
  /**
@@ -9765,7 +11394,7 @@ interface TurboRepoOptions {
9765
11394
  */
9766
11395
  readonly globalPassThroughEnv?: Array<string>;
9767
11396
  /**
9768
- * @default: "stream"
11397
+ * @default "stream"
9769
11398
  *
9770
11399
  * Select a terminal UI for the repository.
9771
11400
  *
@@ -9776,7 +11405,7 @@ interface TurboRepoOptions {
9776
11405
  */
9777
11406
  readonly ui?: "tui" | "stream";
9778
11407
  /**
9779
- * @default: false
11408
+ * @default false
9780
11409
  *
9781
11410
  * Turborepo uses your repository's lockfile to determine caching behavior,
9782
11411
  * Package Graphs, and more. Because of this, we use the packageManager field
@@ -9793,7 +11422,7 @@ interface TurboRepoOptions {
9793
11422
  */
9794
11423
  readonly dangerouslyDisablePackageManagerCheck?: boolean;
9795
11424
  /**
9796
- * @default: ".turbo/cache"
11425
+ * @default ".turbo/cache"
9797
11426
  *
9798
11427
  * Specify the filesystem cache directory.
9799
11428
  *
@@ -9810,7 +11439,7 @@ interface TurboRepoOptions {
9810
11439
  */
9811
11440
  readonly daemon?: boolean;
9812
11441
  /**
9813
- * @default: "strict"
11442
+ * @default "strict"
9814
11443
  *
9815
11444
  * Turborepo's Environment Modes allow you to control which environment
9816
11445
  * variables are available to a task at runtime:
@@ -9835,7 +11464,7 @@ interface TurboRepoOptions {
9835
11464
  /**
9836
11465
  * Env Args that will bre added to turbo's build:all task
9837
11466
  *
9838
- * @default: {}
11467
+ * @default `{}`
9839
11468
  */
9840
11469
  readonly buildAllTaskEnvVars?: Record<string, string>;
9841
11470
  /*****************************************************************************
@@ -9847,31 +11476,31 @@ interface TurboRepoOptions {
9847
11476
  /**
9848
11477
  * Pre compile task
9849
11478
  *
9850
- * @default: "pre-compile"
11479
+ * @default "pre-compile"
9851
11480
  */
9852
11481
  readonly preCompileTask?: Task;
9853
11482
  /**
9854
11483
  * Compile task
9855
11484
  *
9856
- * @default: "compile"
11485
+ * @default "compile"
9857
11486
  */
9858
11487
  readonly compileTask?: Task;
9859
11488
  /**
9860
11489
  * Post compile task
9861
11490
  *
9862
- * @default: "post-compile"
11491
+ * @default "post-compile"
9863
11492
  */
9864
11493
  readonly postCompileTask?: Task;
9865
11494
  /**
9866
11495
  * Test task
9867
11496
  *
9868
- * @default: "test"
11497
+ * @default "test"
9869
11498
  */
9870
11499
  readonly testTask?: Task;
9871
11500
  /**
9872
11501
  * Package task
9873
11502
  *
9874
- * @default: "package"
11503
+ * @default "package"
9875
11504
  */
9876
11505
  readonly packageTask?: Task;
9877
11506
  }
@@ -9932,7 +11561,7 @@ declare class TurboRepo extends Component$1 {
9932
11561
  */
9933
11562
  readonly globalPassThroughEnv: Array<string>;
9934
11563
  /**
9935
- * @default: "stream"
11564
+ * @default "stream"
9936
11565
  *
9937
11566
  * Select a terminal UI for the repository.
9938
11567
  *
@@ -9943,7 +11572,7 @@ declare class TurboRepo extends Component$1 {
9943
11572
  */
9944
11573
  readonly ui: "tui" | "stream";
9945
11574
  /**
9946
- * @default: false
11575
+ * @default false
9947
11576
  *
9948
11577
  * Turborepo uses your repository's lockfile to determine caching behavior,
9949
11578
  * Package Graphs, and more. Because of this, we use the packageManager field
@@ -9960,7 +11589,7 @@ declare class TurboRepo extends Component$1 {
9960
11589
  */
9961
11590
  readonly dangerouslyDisablePackageManagerCheck: boolean;
9962
11591
  /**
9963
- * @default: ".turbo/cache"
11592
+ * @default ".turbo/cache"
9964
11593
  *
9965
11594
  * Specify the filesystem cache directory.
9966
11595
  *
@@ -9976,7 +11605,7 @@ declare class TurboRepo extends Component$1 {
9976
11605
  */
9977
11606
  readonly daemon: boolean;
9978
11607
  /**
9979
- * @default: "strict"
11608
+ * @default "strict"
9980
11609
  *
9981
11610
  * Turborepo's Environment Modes allow you to control which environment
9982
11611
  * variables are available to a task at runtime:
@@ -10193,7 +11822,7 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
10193
11822
  /**
10194
11823
  * The version of PNPM to use in the monorepo.
10195
11824
  * @default VERSION.PNPM_VERSION
10196
- * @see {@link src/versions.ts}
11825
+ * @see `src/versions.ts`
10197
11826
  */
10198
11827
  version?: string;
10199
11828
  /**
@@ -10211,7 +11840,7 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
10211
11840
  */
10212
11841
  readonly approveMergeUpgradeOptions?: ApproveMergeUpgradeOptions;
10213
11842
  /**
10214
- * Whether this monorepo consumes @codedrifters/configulator from a registry (npm).
11843
+ * Whether this monorepo consumes `@codedrifters/configulator` from a registry (npm).
10215
11844
  * When true, the upgrade workflow adds steps to sync configulator and synthesize.
10216
11845
  * Set to false when configulator is developed in this repo (e.g. workspace dependency).
10217
11846
  *
@@ -10227,7 +11856,7 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
10227
11856
  * - `ProjectMetadataOptions`: explicit metadata configuration
10228
11857
  * - `false`: disable ProjectMetadata entirely
10229
11858
  *
10230
- * @default {} (auto-detect from package.json)
11859
+ * @default `{}` (auto-detect from package.json)
10231
11860
  */
10232
11861
  readonly projectMetadata?: ProjectMetadataOptions | false;
10233
11862
  /**
@@ -10501,8 +12130,8 @@ declare class ProjectMetadata extends Component {
10501
12130
  /**
10502
12131
  * Return the maintainer-seed addendum for the `project-context`
10503
12132
  * bundle, or an empty string when the root project either has no
10504
- * layout-enforcement opinion or has opted out (`layoutEnforcement:
10505
- * "off"`).
12133
+ * layout-enforcement opinion or has opted out
12134
+ * (`layoutEnforcement: "off"`).
10506
12135
  *
10507
12136
  * Uses duck-typing on the root project's `layoutEnforcement`
10508
12137
  * property to avoid a circular import with `MonorepoProject`. The
@@ -10727,7 +12356,7 @@ interface StarlightProjectOptions extends AstroProjectOptions {
10727
12356
  */
10728
12357
  readonly editLink?: StarlightEditLink;
10729
12358
  /**
10730
- * @astrojs/starlight package version.
12359
+ * `@astrojs/starlight` package version.
10731
12360
  *
10732
12361
  * @default VERSION.STARLIGHT_VERSION
10733
12362
  */
@@ -10779,7 +12408,7 @@ declare const COMPLETE_JOB_ID = "complete";
10779
12408
  * Call this for the default build workflow and for any build workflow created
10780
12409
  * by Configulator (e.g. AwsDeployWorkflow).
10781
12410
  *
10782
- * @param buildWorkflow The Projen BuildWorkflow to append the complete job to.
12411
+ * @param buildWorkflow - The Projen BuildWorkflow to append the complete job to.
10783
12412
  */
10784
12413
  declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
10785
12414
 
@@ -10807,7 +12436,7 @@ declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
10807
12436
  * (e.g. the upgrade workflow). Steps held inside lazy closures
10808
12437
  * are skipped — those are reached via pass 1.
10809
12438
  *
10810
- * @param project The project whose GitHub workflows should be patched.
12439
+ * @param project - The project whose GitHub workflows should be patched.
10811
12440
  */
10812
12441
  declare function pinPnpmActionSetup(project: Project): void;
10813
12442
 
@@ -10855,9 +12484,9 @@ declare function pinPnpmActionSetup(project: Project): void;
10855
12484
  * untouched. The step's `uses` field is also left alone — this
10856
12485
  * helper pins the input, not the action version pin.
10857
12486
  *
10858
- * @param project The project whose GitHub workflows should be patched.
12487
+ * @param project - The project whose GitHub workflows should be patched.
10859
12488
  */
10860
12489
  declare function pinSetupNodeVersion(project: Project): void;
10861
12490
 
10862
- export { AGENT_MODEL, AGENT_PLATFORM, AGENT_REGISTRY_ENTRIES, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AUDIT_CATEGORY_ORDER, AgentConfig, ApiExtractor, AstroConfig, AstroOutput, AstroProject, AuditCategory, AuditMode, AuditSeverity, AwsCdkProject, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, AwsTeardownWorkflow, BUILT_IN_BUNDLES, BUNDLE_OWNERSHIP, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_AUDIT_REPORT_DIR, DEFAULT_BUNDLE_OVERRIDES, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_PRIORITY, DEFAULT_ISSUE_STATUS, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_RESOLVED_ISSUE_DEFAULTS, DEFAULT_SAMPLE_COMPILER_OPTIONS, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TEMPORAL_FRAMING_CADENCES, DEFAULT_TEMPORAL_FRAMING_EMIT_CHECKER, DEFAULT_TEMPORAL_FRAMING_ENABLED, DEFAULT_TEMPORAL_FRAMING_PATHS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_UPSTREAM_CONFIGULATOR_ENABLED, DOCS_SYNC_AUDIT_SCHEMA_VERSION, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, MAX_LABEL_DESCRIPTION_LENGTH, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, MonorepoProject, Nvmrc, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, ProjectMetadata, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ReactViteSiteProject, ResetTask, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, SUPPRESSED_WORKFLOW_RULE_NAMES, SampleLang, StarlightProject, TEMPORAL_FRAMING_CATEGORY_VALUES, TestRunner, TsDocCoverageKind, TsdocConfig, TurboRepo, TurboRepoTask, TypeScriptConfig, TypeScriptProject, UNKNOWN_TYPE_FALLBACK_TIER, VALID_PRIORITY_VALUES, VALID_STATUS_VALUES, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, Vitest, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addPlaywright, addStorybook, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, auditReportJsonSchema, awsCdkBundle, baseBundle, bcmWriterBundle, buildAgentRegistryRule, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildMeetingAnalysisBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildReport, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, bundleNameForWorkflowRule, businessModelsBundle, checkDocSamplesProcedure, checkLinksProcedure, classifyIssueScope, classifyRun, companyProfileBundle, compileFencedSamples, createApiDiffCheck, createReferenceMismatchCheck, createTsdocCoverageCheck, customerProfileBundle, diffApiRollups, docsSyncBundle, emptyCategoryBuckets, extractApiProcedure, extractDocReferences, extractFencedSamples, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, hasAnyDocsEmittingBundle, hasAnyDownstreamIssueKindBundle, industryDiscoveryBundle, isPhaseLabelOwnedByExcluded, isScheduledTaskOwnedByExcluded, isSuppressedWorkflowRule, isTypeLabelOwnedByExcluded, jestBundle, labelsForPhase, maintenanceAuditBundle, meetingAnalysisBundle, orchestratorBundle, parseApiRollup, peopleProfileBundle, persistAuditReport, pinPnpmActionSetup, pinSetupNodeVersion, pnpmBundle, prReviewBundle, projenBundle, referenceRecordToFinding, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCheckDocSamplesProcedure, renderCheckLinksProcedure, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderStubIndexConventionRuleContent, renderTemporalFramingCheckerScript, renderTemporalFramingRuleContent, renderUnblockDependentsScript, renderUnblockDependentsSection, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueDefaults, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolveOverrideForLabels, resolveProgressFiles, resolveReactViteSiteProjectOutdir, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTemporalFraming, resolveTypeScriptProjectOutdir, resolveUnblockDependents, runScan, slackBundle, softwareProfileBundle, standardsResearchBundle, tsdocRecordToFindings, turborepoBundle, typescriptBundle, upstreamConfigulatorDocsBundle, validateAgentTierConfig, validateIssueDefaultsConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateTemporalFramingConfig, validateUnblockDependentsConfig, vitestBundle };
10863
- export type { ActivateBranchNameEnvVarOptions, AddStorybookOptions, AgentCommand, AgentConfigOptions, AgentExpansionRules, AgentFeaturesConfig, AgentModel, AgentPathsConfig, AgentPlatform, AgentPlatformOverrides, AgentProcedure, AgentRegistryEntry, AgentRule, AgentRuleBundle, AgentRuleScope, AgentSkill, AgentSubAgent, AgentSubAgentPlatformOverrides, AgentTier, AgentTierConfig, AgentTierEntry, AnalyzeTsDocCoverageOptions, ApiDiffCheckOptions, ApiDiffFinding, ApiDiffResult, ApiExtractorOptions, ApiExtractorReportOptions, ApiSurfaceEntry, ApproveMergeUpgradeOptions, AstroConfigOptions, AstroIntegrationSpec, AstroProjectOptions, AuditCheckRunner, AuditCheckRunnerContext, AuditFinding, AuditFindingBase, AuditLocation, AuditReport, AwsAccount, AwsCdkProjectOptions, AwsDeploymentTargetOptions, AwsLocalDeploymentConfig, AwsOrganization, AwsRegion, AwsTeardownWorkflowOptions, BundleOwnership, CiDeploymentConfig, ClassTypeOptions, ClaudeAutoModeConfig, ClaudeHookAction, ClaudeHookEntry, ClaudeHooksConfig, ClaudeMdConfig, ClaudePermissionsConfig, ClaudeRuleTarget, ClaudeSandboxConfig, ClaudeSettingsConfig, CompileFencedSamplesOptions, CopilotHandoff, CursorHookAction, CursorHooksConfig, CursorSettingsConfig, CustomDocSection, DeployWorkflowOptions, DeploymentMetadata, DocReferenceRecord, EffectiveScopeThresholds, ExtractDocReferencesOptions, ExtractFencedSamplesOptions, FencedSampleRecord, FocusArea, FocusAreaMatch, FocusConfig, GitBranch, GitHubBoardMetadata, GitHubProjectMetadata, GitHubSprintMetadata, IDependencyResolver, IssueDefaultsConfig, IssueDefaultsOverride, IssueDefaultsPriority, IssueDefaultsStatus, IssueTemplatesConfig, LabelDefinition, LayoutEnforcement, LayoutViolation, LinkFailureFinding, McpServerConfig, McpTransport, MeetingArea, MeetingScope, MeetingType, MeetingTypeKind, MeetingsConfig, MergeMethod, MonorepoLayoutRoot, MonorepoProjectOptions, OrganizationMetadata, PnpmWorkspaceOptions, PriorityRule, ProgressFilesConfig, ProjectMetadataOptions, ReactViteSiteProjectOptions, ReferenceMismatchCheckOptions, ReferenceMismatchFinding, RemoteCacheOptions, RepositoryMetadata, ResetTaskOptions, ResolvedAgentPaths, ResolvedAgentTier, ResolvedIssueDefaults, ResolvedIssueDefaultsEntry, ResolvedIssueTemplates, ResolvedProgressFiles, ResolvedProjectMetadata, ResolvedRunRatio, ResolvedScheduledTask, ResolvedScheduledTasks, ResolvedScopeGate, ResolvedScopeGateBundleOverride, ResolvedSharedEditing, ResolvedSkillEvals, ResolvedTemporalFraming, ResolvedUnblockDependents, RunRatioConfig, RunScanOptions, RunScanResult, SampleCompilationFailure, SampleFailureFinding, ScheduledTaskEntry, ScheduledTaskModel, ScheduledTaskOverride, ScheduledTasksConfig, ScopeClass, ScopeGateBundleOverride, ScopeGateConfig, ScopeGateThresholds, SharedEditingConfig, SkillEvalsConfig, SlackMetadata, SourceTierExamples, StarlightEditLink, StarlightLogo, StarlightProjectOptions, StarlightRole, StarlightSidebarItem, StarlightSingletonViolation, StarlightSocialLink, SyncLabelsOptions, TemplateResolveResult, TemporalFramingCategory, TemporalFramingConfig, TsDocCoverageRecord, TsdocConfigOptions, TsdocCoverageCheckOptions, TsdocCoverageFinding, TurboRepoOptions, TurboRepoTaskOptions, TypeScriptProjectOptions, UnblockDependentsConfig, UpstreamConfigulatorConfig, VersionKey, VitestConfigOptions, VitestOptions };
12491
+ export { AGENT_MODEL, AGENT_PLATFORM, AGENT_REGISTRY_ENTRIES, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AUDIT_CATEGORY_ORDER, AgentConfig, ApiExtractor, AstroConfig, AstroOutput, AstroProject, AuditCategory, AuditMode, AuditSeverity, AwsCdkProject, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, AwsTeardownWorkflow, BUILT_IN_BUNDLES, BUNDLE_OWNERSHIP, CDK_BOOTSTRAP_DEFAULTS_BY_STAGE, CDK_DEPLOY_DEFAULTS_BY_STAGE, CDK_DEPLOY_METHOD, CDK_DESTROY_DEFAULTS_BY_STAGE, CDK_DIFF_DEFAULTS_BY_STAGE, CDK_DIFF_METHOD, CDK_GC_ACTION, CDK_GC_TYPE, CDK_INIT_LANGUAGE, CDK_INIT_TEMPLATE, CDK_PROGRESS, CDK_REQUIRE_APPROVAL, CDK_SYNTH_DEFAULTS_BY_STAGE, CDK_WATCH_DEFAULTS_BY_STAGE, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, CdkCli, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_AUDIT_REPORT_DIR, DEFAULT_BUNDLE_OVERRIDES, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_PRIORITY, DEFAULT_ISSUE_STATUS, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_RESOLVED_ISSUE_DEFAULTS, DEFAULT_SAMPLE_COMPILER_OPTIONS, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TEMPORAL_FRAMING_CADENCES, DEFAULT_TEMPORAL_FRAMING_EMIT_CHECKER, DEFAULT_TEMPORAL_FRAMING_ENABLED, DEFAULT_TEMPORAL_FRAMING_PATHS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_UPSTREAM_CONFIGULATOR_ENABLED, DOCS_SYNC_AUDIT_SCHEMA_VERSION, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, MAX_LABEL_DESCRIPTION_LENGTH, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, MonorepoProject, Nvmrc, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, ProjectMetadata, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ReactViteSiteProject, ResetTask, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, SUPPRESSED_WORKFLOW_RULE_NAMES, SampleLang, StarlightProject, TEMPORAL_FRAMING_CATEGORY_VALUES, TestRunner, TsDocCoverageKind, TsdocConfig, TurboRepo, TurboRepoTask, TypeScriptConfig, TypeScriptProject, UNKNOWN_TYPE_FALLBACK_TIER, VALID_PRIORITY_VALUES, VALID_STATUS_VALUES, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, Vitest, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addPlaywright, addStorybook, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, auditReportJsonSchema, awsCdkBundle, baseBundle, bcmWriterBundle, buildAgentRegistryRule, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildMeetingAnalysisBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildReport, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, bundleNameForWorkflowRule, businessModelsBundle, checkDocSamplesProcedure, checkLinksProcedure, classifyIssueScope, classifyRun, companyProfileBundle, compileFencedSamples, createApiDiffCheck, createReferenceMismatchCheck, createTsdocCoverageCheck, customerProfileBundle, diffApiRollups, docsSyncBundle, emptyCategoryBuckets, extractApiProcedure, extractDocReferences, extractFencedSamples, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, hasAnyDocsEmittingBundle, hasAnyDownstreamIssueKindBundle, industryDiscoveryBundle, isPhaseLabelOwnedByExcluded, isScheduledTaskOwnedByExcluded, isSuppressedWorkflowRule, isTypeLabelOwnedByExcluded, jestBundle, labelsForPhase, maintenanceAuditBundle, meetingAnalysisBundle, mergeCdkOptions, orchestratorBundle, parseApiRollup, peopleProfileBundle, persistAuditReport, pinPnpmActionSetup, pinSetupNodeVersion, pnpmBundle, prReviewBundle, projenBundle, referenceRecordToFinding, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCdkAcknowledge, renderCdkBootstrap, renderCdkContext, renderCdkDeploy, renderCdkDestroy, renderCdkDiff, renderCdkDocs, renderCdkDoctor, renderCdkDrift, renderCdkFlags, renderCdkGc, renderCdkImport, renderCdkInit, renderCdkList, renderCdkMetadata, renderCdkMigrate, renderCdkNotices, renderCdkOrphan, renderCdkPublishAssets, renderCdkRefactor, renderCdkRollback, renderCdkSynth, renderCdkWatch, renderCheckDocSamplesProcedure, renderCheckLinksProcedure, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderStubIndexConventionRuleContent, renderTemporalFramingCheckerScript, renderTemporalFramingRuleContent, renderUnblockDependentsScript, renderUnblockDependentsSection, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueDefaults, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolveOverrideForLabels, resolveProgressFiles, resolveReactViteSiteProjectOutdir, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTemporalFraming, resolveTypeScriptProjectOutdir, resolveUnblockDependents, runScan, slackBundle, softwareProfileBundle, standardsResearchBundle, tsdocRecordToFindings, turborepoBundle, typescriptBundle, upstreamConfigulatorDocsBundle, validateAgentTierConfig, validateIssueDefaultsConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateTemporalFramingConfig, validateUnblockDependentsConfig, vitestBundle };
12492
+ export type { ActivateBranchNameEnvVarOptions, AddStorybookOptions, AgentCommand, AgentConfigOptions, AgentExpansionRules, AgentFeaturesConfig, AgentModel, AgentPathsConfig, AgentPlatform, AgentPlatformOverrides, AgentProcedure, AgentRegistryEntry, AgentRule, AgentRuleBundle, AgentRuleScope, AgentSkill, AgentSubAgent, AgentSubAgentPlatformOverrides, AgentTier, AgentTierConfig, AgentTierEntry, AnalyzeTsDocCoverageOptions, ApiDiffCheckOptions, ApiDiffFinding, ApiDiffResult, ApiExtractorOptions, ApiExtractorReportOptions, ApiSurfaceEntry, ApproveMergeUpgradeOptions, AstroConfigOptions, AstroIntegrationSpec, AstroProjectOptions, AuditCheckRunner, AuditCheckRunnerContext, AuditFinding, AuditFindingBase, AuditLocation, AuditReport, AwsAccount, AwsCdkProjectOptions, AwsDeploymentTargetOptions, AwsLocalDeploymentConfig, AwsOrganization, AwsRegion, AwsTeardownWorkflowOptions, BundleOwnership, CdkAcknowledgeOptions, CdkBootstrapOptions, CdkCliOptions, CdkContextOptions, CdkDeployMethod, CdkDeployOptions, CdkDestroyOptions, CdkDiffMethod, CdkDiffOptions, CdkDocsOptions, CdkDoctorOptions, CdkDriftOptions, CdkFlagsOptions, CdkGcAction, CdkGcOptions, CdkGcType, CdkGlobalOptions, CdkImportOptions, CdkInitLanguage, CdkInitOptions, CdkInitTemplate, CdkListOptions, CdkMetadataOptions, CdkMigrateOptions, CdkNoticesOptions, CdkOrphanOptions, CdkProgress, CdkPublishAssetsOptions, CdkRefactorOptions, CdkRequireApproval, CdkRollbackOptions, CdkSynthOptions, CdkTargetOverrides, CdkWatchOptions, CiDeploymentConfig, ClassTypeOptions, ClaudeAutoModeConfig, ClaudeHookAction, ClaudeHookEntry, ClaudeHooksConfig, ClaudeMdConfig, ClaudePermissionsConfig, ClaudeRuleTarget, ClaudeSandboxConfig, ClaudeSettingsConfig, CompileFencedSamplesOptions, CopilotHandoff, CursorHookAction, CursorHooksConfig, CursorSettingsConfig, CustomDocSection, DeployWorkflowOptions, DeploymentMetadata, DocReferenceRecord, EffectiveScopeThresholds, ExtractDocReferencesOptions, ExtractFencedSamplesOptions, FencedSampleRecord, FocusArea, FocusAreaMatch, FocusConfig, GitBranch, GitHubBoardMetadata, GitHubProjectMetadata, GitHubSprintMetadata, IDependencyResolver, IssueDefaultsConfig, IssueDefaultsOverride, IssueDefaultsPriority, IssueDefaultsStatus, IssueTemplatesConfig, LabelDefinition, LayoutEnforcement, LayoutViolation, LinkFailureFinding, McpServerConfig, McpTransport, MeetingArea, MeetingScope, MeetingType, MeetingTypeKind, MeetingsConfig, MergeMethod, MonorepoLayoutRoot, MonorepoProjectOptions, OrganizationMetadata, PnpmWorkspaceOptions, PriorityRule, ProgressFilesConfig, ProjectMetadataOptions, ReactViteSiteProjectOptions, ReferenceMismatchCheckOptions, ReferenceMismatchFinding, RemoteCacheOptions, RepositoryMetadata, ResetTaskOptions, ResolvedAgentPaths, ResolvedAgentTier, ResolvedIssueDefaults, ResolvedIssueDefaultsEntry, ResolvedIssueTemplates, ResolvedProgressFiles, ResolvedProjectMetadata, ResolvedRunRatio, ResolvedScheduledTask, ResolvedScheduledTasks, ResolvedScopeGate, ResolvedScopeGateBundleOverride, ResolvedSharedEditing, ResolvedSkillEvals, ResolvedTemporalFraming, ResolvedUnblockDependents, RunRatioConfig, RunScanOptions, RunScanResult, SampleCompilationFailure, SampleFailureFinding, ScheduledTaskEntry, ScheduledTaskModel, ScheduledTaskOverride, ScheduledTasksConfig, ScopeClass, ScopeGateBundleOverride, ScopeGateConfig, ScopeGateThresholds, SharedEditingConfig, SkillEvalsConfig, SlackMetadata, SourceTierExamples, StarlightEditLink, StarlightLogo, StarlightProjectOptions, StarlightRole, StarlightSidebarItem, StarlightSingletonViolation, StarlightSocialLink, SyncLabelsOptions, TemplateResolveResult, TemporalFramingCategory, TemporalFramingConfig, TsDocCoverageRecord, TsdocConfigOptions, TsdocCoverageCheckOptions, TsdocCoverageFinding, TurboRepoOptions, TurboRepoTaskOptions, TypeScriptProjectOptions, UnblockDependentsConfig, UpstreamConfigulatorConfig, VersionKey, VitestConfigOptions, VitestOptions };