@guardian/cdk 0.0.0-canary-20260805130549

package/README.md

@@ -0,0 +1,50 @@
+# Guardian CDK Library
+
+![npm][badge-npm] [![CD][badge-cd]][internal-cd-file]
+
+[badge-cd]: https://github.com/guardian/cdk/actions/workflows/cd.yaml/badge.svg
+[badge-npm]: https://img.shields.io/npm/v/@guardian/cdk?style=flat-square
+[internal-cd-file]: https://github.com/guardian/cdk/actions/workflows/cd.yaml
+
+The [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) (AWS CDK) is an open-source software
+development framework to define cloud infrastructure in code and provision it
+through AWS CloudFormation.
+
+`@guardian/cdk` builds on CDK to provide Guardian-specific [patterns](./src/patterns) and
+[constructs](./src/constructs). It is an opinionated and secure-by-default way to describe and
+provision your AWS resources.
+
+Jump to:
+
+- [Quickstart](#quickstart)
+- [CDK demo including screencast](https://github.com/guardian/cdk-demo)
+- [Setting up a new project](./docs/setting-up-a-gucdk-project.md)
+- [Migrating an existing Cloudformation template](./docs/migration-guide.md)
+- View the [typedocs](https://guardian.github.io/cdk/)
+- [Contributing](#contributing) to `@guardian/cdk`
+- [Best practices](./docs/best-practices.md)
+
+## Quickstart
+
+`@guardian/cdk` expects certain Parameter Store values to be present - for
+example, VPC IDs, and the location of dist buckets. To check for account
+readiness and fix any issues, run:
+
+    npx @guardian/cdk@latest account-readiness --profile [profile]
+
+Once you've confirmed that your account is ready, you can start provisioning your infrastructure.
+
+> Tip: Setting up a new project? [Start here!](./docs/setting-up-a-gucdk-project.md)
+
+> Tip: Migrating an app? See the [Migration Guide](./docs/migration-guide.md) for more detail.
+
+> Tip: New to CDK? The [AWS CDK Developer Guide](https://docs.aws.amazon.com/cdk/v2/guide/home.html) is worth a read.
+
+## Contributing
+
+We welcome contributions to `@guardian/cdk`!
+
+To get started, please read our [Contribution Guidelines](./docs/contributing.md).
+
+> [!NOTE]
+> This repository uses the GitHub App [guardian/cdk](https://github.com/organizations/guardian/settings/apps/guardian-cdk) (requires GitHub admin) for various automations.

package/bin/gu-cdk

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+// The file `index.js` is created at build time.
+// To use the CLI locally run `./script/cli`.
+require('../lib/bin/index.js');

package/lib/aspects/cfn-include-reporter.d.ts

@@ -0,0 +1,9 @@
+import type { IAspect } from "aws-cdk-lib";
+import type { IConstruct } from "constructs";
+/**
+ * An Aspect to remind users to check for stateful resources when migrating a YAML/JSON template.
+ */
+export declare class CfnIncludeReporter implements IAspect {
+    visit(node: IConstruct): void;
+}
+//# sourceMappingURL=cfn-include-reporter.d.ts.map

package/lib/aspects/cfn-include-reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cfn-include-reporter.d.ts","sourceRoot":"","sources":["../../src/aspects/cfn-include-reporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAG3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C;;GAEG;AACH,qBAAa,kBAAmB,YAAW,OAAO;IACzC,KAAK,CAAC,IAAI,EAAE,UAAU;CAO9B"}

package/lib/aspects/cfn-include-reporter.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CfnIncludeReporter = void 0;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const cloudformation_include_1 = require("aws-cdk-lib/cloudformation-include");
+const constants_1 = require("../constants");
+/**
+ * An Aspect to remind users to check for stateful resources when migrating a YAML/JSON template.
+ */
+class CfnIncludeReporter {
+    visit(node) {
+        if (node instanceof cloudformation_include_1.CfnInclude) {
+            aws_cdk_lib_1.Annotations.of(node).addWarning(`As you're migrating a YAML/JSON template to ${constants_1.LibraryInfo.NAME}, be sure to check for any stateful resources! See https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md.`);
+        }
+    }
+}
+exports.CfnIncludeReporter = CfnIncludeReporter;
+//# sourceMappingURL=cfn-include-reporter.js.map

package/lib/aspects/cfn-include-reporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cfn-include-reporter.js","sourceRoot":"","sources":["../../src/aspects/cfn-include-reporter.ts"],"names":[],"mappings":";;;AACA,6CAA0C;AAC1C,+EAAgE;AAEhE,4CAA2C;AAE3C;;GAEG;AACH,MAAa,kBAAkB;IACtB,KAAK,CAAC,IAAgB;QAC3B,IAAI,IAAI,YAAY,mCAAU,EAAE,CAAC;YAC/B,yBAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,CAC7B,+CAA+C,uBAAW,CAAC,IAAI,0HAA0H,CAC1L,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AARD,gDAQC","sourcesContent":["import type { IAspect } from \"aws-cdk-lib\";\nimport { Annotations } from \"aws-cdk-lib\";\nimport { CfnInclude } from \"aws-cdk-lib/cloudformation-include\";\nimport type { IConstruct } from \"constructs\";\nimport { LibraryInfo } from \"../constants\";\n\n/**\n * An Aspect to remind users to check for stateful resources when migrating a YAML/JSON template.\n */\nexport class CfnIncludeReporter implements IAspect {\n  public visit(node: IConstruct) {\n    if (node instanceof CfnInclude) {\n      Annotations.of(node).addWarning(\n        `As you're migrating a YAML/JSON template to ${LibraryInfo.NAME}, be sure to check for any stateful resources! See https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md.`,\n      );\n    }\n  }\n}\n"]}

package/lib/aspects/cfn-parameter-reporter.d.ts

@@ -0,0 +1,9 @@
+import type { IAspect } from "aws-cdk-lib";
+import type { IConstruct } from "constructs";
+/**
+ * An Aspect to remind users to check Parameters to ensure Riff-Raff can successfully deploy the stack.
+ */
+export declare class CfnParameterReporter implements IAspect {
+    visit(node: IConstruct): void;
+}
+//# sourceMappingURL=cfn-parameter-reporter.d.ts.map

package/lib/aspects/cfn-parameter-reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cfn-parameter-reporter.d.ts","sourceRoot":"","sources":["../../src/aspects/cfn-parameter-reporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C;;GAEG;AACH,qBAAa,oBAAqB,YAAW,OAAO;IAC3C,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;CAarC"}

package/lib/aspects/cfn-parameter-reporter.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CfnParameterReporter = void 0;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+/**
+ * An Aspect to remind users to check Parameters to ensure Riff-Raff can successfully deploy the stack.
+ */
+class CfnParameterReporter {
+    visit(node) {
+        if (node instanceof aws_cdk_lib_1.CfnParameter) {
+            const defaultValue = node.default;
+            const hasDefault = !!defaultValue;
+            const isSsmParameter = node.type.startsWith("AWS::SSM::Parameter::Value");
+            if (isSsmParameter && hasDefault) {
+                aws_cdk_lib_1.Annotations.of(node.stack).addInfo(`Stack reads the SSM Parameter '${defaultValue}'. Ensure it exists prior to deployment.`);
+            }
+        }
+    }
+}
+exports.CfnParameterReporter = CfnParameterReporter;
+//# sourceMappingURL=cfn-parameter-reporter.js.map

package/lib/aspects/cfn-parameter-reporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cfn-parameter-reporter.js","sourceRoot":"","sources":["../../src/aspects/cfn-parameter-reporter.ts"],"names":[],"mappings":";;;AACA,6CAAwD;AAGxD;;GAEG;AACH,MAAa,oBAAoB;IACxB,KAAK,CAAC,IAAgB;QAC3B,IAAI,IAAI,YAAY,0BAAY,EAAE,CAAC;YACjC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAiB,CAAC;YAC5C,MAAM,UAAU,GAAG,CAAC,CAAC,YAAY,CAAC;YAClC,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAAC;YAE1E,IAAI,cAAc,IAAI,UAAU,EAAE,CAAC;gBACjC,yBAAW,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAChC,kCAAkC,YAAY,0CAA0C,CACzF,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAdD,oDAcC","sourcesContent":["import type { IAspect } from \"aws-cdk-lib\";\nimport { Annotations, CfnParameter } from \"aws-cdk-lib\";\nimport type { IConstruct } from \"constructs\";\n\n/**\n * An Aspect to remind users to check Parameters to ensure Riff-Raff can successfully deploy the stack.\n */\nexport class CfnParameterReporter implements IAspect {\n  public visit(node: IConstruct): void {\n    if (node instanceof CfnParameter) {\n      const defaultValue = node.default as string;\n      const hasDefault = !!defaultValue;\n      const isSsmParameter = node.type.startsWith(\"AWS::SSM::Parameter::Value\");\n\n      if (isSsmParameter && hasDefault) {\n        Annotations.of(node.stack).addInfo(\n          `Stack reads the SSM Parameter '${defaultValue}'. Ensure it exists prior to deployment.`,\n        );\n      }\n    }\n  }\n}\n"]}

package/lib/aspects/metadata.d.ts

@@ -0,0 +1,8 @@
+import type { IAspect, Stack } from "aws-cdk-lib";
+import type { IConstruct } from "constructs";
+export declare class Metadata implements IAspect {
+    readonly stack: Stack;
+    constructor(s: Stack);
+    visit(node: IConstruct): void;
+}
+//# sourceMappingURL=metadata.d.ts.map

package/lib/aspects/metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/aspects/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,qBAAa,QAAS,YAAW,OAAO;IACtC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;gBAGH,CAAC,EAAE,KAAK;IAapB,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;CASrC"}

package/lib/aspects/metadata.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metadata = void 0;
+const constants_1 = require("../constants");
+class Metadata {
+    // eslint-disable-next-line custom-rules/valid-constructors -- doesn't apply here
+    constructor(s) {
+        this.stack = s;
+        this.stack.templateOptions.metadata = {
+            [constants_1.MetadataKeys.CONSTRUCTS_KEY]: [],
+            /*
+            `TrackingTag.Value` is a proxy to `LibraryInfo.VERSION`.
+            Intentionally using `TrackingTag.Value` so that the published mock can be used.
+             */
+            [constants_1.MetadataKeys.VERSION]: constants_1.TrackingTag.Value,
+        };
+    }
+    visit(node) {
+        const metadata = this.stack.templateOptions.metadata;
+        const name = node.constructor.name;
+        // We assume any construct named Gu* is part of our public API.
+        if (metadata && name.startsWith("Gu")) {
+            metadata[constants_1.MetadataKeys.CONSTRUCTS_KEY].push(name);
+        }
+    }
+}
+exports.Metadata = Metadata;
+//# sourceMappingURL=metadata.js.map

package/lib/aspects/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/aspects/metadata.ts"],"names":[],"mappings":";;;AAEA,4CAAyD;AAEzD,MAAa,QAAQ;IAGnB,iFAAiF;IACjF,YAAmB,CAAQ;QACzB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,QAAQ,GAAG;YACpC,CAAC,wBAAY,CAAC,cAAc,CAAC,EAAE,EAAE;YAEjC;;;eAGG;YACH,CAAC,wBAAY,CAAC,OAAO,CAAC,EAAE,uBAAW,CAAC,KAAK;SAC1C,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,IAAgB;QAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,QAAQ,CAAC;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAEnC,+DAA+D;QAC/D,IAAI,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,QAAQ,CAAC,wBAAY,CAAC,cAAc,CAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;CACF;AA1BD,4BA0BC","sourcesContent":["import type { IAspect, Stack } from \"aws-cdk-lib\";\nimport type { IConstruct } from \"constructs\";\nimport { MetadataKeys, TrackingTag } from \"../constants\";\n\nexport class Metadata implements IAspect {\n  readonly stack: Stack;\n\n  // eslint-disable-next-line custom-rules/valid-constructors -- doesn't apply here\n  public constructor(s: Stack) {\n    this.stack = s;\n    this.stack.templateOptions.metadata = {\n      [MetadataKeys.CONSTRUCTS_KEY]: [],\n\n      /*\n      `TrackingTag.Value` is a proxy to `LibraryInfo.VERSION`.\n      Intentionally using `TrackingTag.Value` so that the published mock can be used.\n       */\n      [MetadataKeys.VERSION]: TrackingTag.Value,\n    };\n  }\n\n  public visit(node: IConstruct): void {\n    const metadata = this.stack.templateOptions.metadata;\n    const name = node.constructor.name;\n\n    // We assume any construct named Gu* is part of our public API.\n    if (metadata && name.startsWith(\"Gu\")) {\n      (metadata[MetadataKeys.CONSTRUCTS_KEY] as string[]).push(name);\n    }\n  }\n}\n"]}

package/lib/bin/aws-credential-provider.d.ts

@@ -0,0 +1,3 @@
+import type { AwsCredentialIdentityProvider } from "@aws-sdk/types";
+export declare const awsCredentialProviderChain: (profile: string | undefined) => AwsCredentialIdentityProvider;
+//# sourceMappingURL=aws-credential-provider.d.ts.map

package/lib/bin/aws-credential-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-credential-provider.d.ts","sourceRoot":"","sources":["../../src/bin/aws-credential-provider.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAEpE,eAAO,MAAM,0BAA0B,GAAI,SAAS,MAAM,GAAG,SAAS,KAAG,6BAExE,CAAC"}

package/lib/bin/aws-credential-provider.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.awsCredentialProviderChain = void 0;
+const credential_providers_1 = require("@aws-sdk/credential-providers");
+const awsCredentialProviderChain = (profile) => {
+    return profile ? (0, credential_providers_1.createCredentialChain)((0, credential_providers_1.fromEnv)(), (0, credential_providers_1.fromIni)({ profile })) : (0, credential_providers_1.createCredentialChain)((0, credential_providers_1.fromEnv)());
+};
+exports.awsCredentialProviderChain = awsCredentialProviderChain;
+//# sourceMappingURL=aws-credential-provider.js.map

package/lib/bin/aws-credential-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-credential-provider.js","sourceRoot":"","sources":["../../src/bin/aws-credential-provider.ts"],"names":[],"mappings":";;;AAAA,wEAAwF;AAGjF,MAAM,0BAA0B,GAAG,CAAC,OAA2B,EAAiC,EAAE;IACvG,OAAO,OAAO,CAAC,CAAC,CAAC,IAAA,4CAAqB,EAAC,IAAA,8BAAO,GAAE,EAAE,IAAA,8BAAO,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,4CAAqB,EAAC,IAAA,8BAAO,GAAE,CAAC,CAAC;AAC7G,CAAC,CAAC;AAFW,QAAA,0BAA0B,8BAErC","sourcesContent":["import { createCredentialChain, fromEnv, fromIni } from \"@aws-sdk/credential-providers\";\nimport type { AwsCredentialIdentityProvider } from \"@aws-sdk/types\";\n\nexport const awsCredentialProviderChain = (profile: string | undefined): AwsCredentialIdentityProvider => {\n  return profile ? createCredentialChain(fromEnv(), fromIni({ profile })) : createCredentialChain(fromEnv());\n};\n"]}

package/lib/bin/commands/account-readiness/index.d.ts

@@ -0,0 +1,11 @@
+import type { AwsConfig, CliCommandResponse } from "../../../types/cli";
+export interface Report {
+    name: string;
+    isPass: boolean;
+    msg?: string;
+    errors: Map<string, string>;
+    parametersFound: number;
+    parametersMissing: number;
+}
+export declare const accountReadinessCommand: (props: AwsConfig) => CliCommandResponse;
+//# sourceMappingURL=index.d.ts.map

package/lib/bin/commands/account-readiness/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/bin/commands/account-readiness/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAGxE,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,eAAO,MAAM,uBAAuB,GAAU,OAAO,SAAS,KAAG,kBAsBhE,CAAC"}

package/lib/bin/commands/account-readiness/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.accountReadinessCommand = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const ssm_1 = require("./ssm");
+const accountReadinessCommand = async (props) => {
+    const report = await (0, ssm_1.report)(props);
+    console.log(chalk_1.default.bold(report.name + ":") + " " + (report.isPass ? "✅ Pass" : "❌ Fail"));
+    if (report.parametersFound === 0) {
+        console.log(`It looks like this account has not been set up for @guardian/cdk yet. See https://github.com/guardian/aws-account-setup`);
+        return 1;
+    }
+    if (!report.isPass) {
+        if (report.msg) {
+            console.log(report.msg + "\n");
+        }
+        report.errors.forEach((errMsg, name) => console.log(`${chalk_1.default.red(name)}: ${errMsg}`));
+        console.log();
+    }
+    return report.isPass ? 0 : 1;
+};
+exports.accountReadinessCommand = accountReadinessCommand;
+//# sourceMappingURL=index.js.map

package/lib/bin/commands/account-readiness/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/bin/commands/account-readiness/index.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,+BAA4C;AAWrC,MAAM,uBAAuB,GAAG,KAAK,EAAE,KAAgB,EAAsB,EAAE;IACpF,MAAM,MAAM,GAAG,MAAM,IAAA,YAAS,EAAC,KAAK,CAAC,CAAC;IAEtC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzF,IAAI,MAAM,CAAC,eAAe,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,CACT,yHAAyH,CAC1H,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC;QACtF,OAAO,CAAC,GAAG,EAAE,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC,CAAC;AAtBW,QAAA,uBAAuB,2BAsBlC","sourcesContent":["import chalk from \"chalk\";\nimport type { AwsConfig, CliCommandResponse } from \"../../../types/cli\";\nimport { report as reportSSM } from \"./ssm\";\n\nexport interface Report {\n  name: string;\n  isPass: boolean;\n  msg?: string;\n  errors: Map<string, string>;\n  parametersFound: number;\n  parametersMissing: number;\n}\n\nexport const accountReadinessCommand = async (props: AwsConfig): CliCommandResponse => {\n  const report = await reportSSM(props);\n\n  console.log(chalk.bold(report.name + \":\") + \" \" + (report.isPass ? \"✅ Pass\" : \"❌ Fail\"));\n\n  if (report.parametersFound === 0) {\n    console.log(\n      `It looks like this account has not been set up for @guardian/cdk yet. See https://github.com/guardian/aws-account-setup`,\n    );\n\n    return 1;\n  }\n\n  if (!report.isPass) {\n    if (report.msg) {\n      console.log(report.msg + \"\\n\");\n    }\n    report.errors.forEach((errMsg, name) => console.log(`${chalk.red(name)}: ${errMsg}`));\n    console.log();\n  }\n\n  return report.isPass ? 0 : 1;\n};\n"]}

package/lib/bin/commands/account-readiness/ssm.d.ts

@@ -0,0 +1,12 @@
+import type { SsmParameterPath } from "../../../constants";
+import type { AwsConfig } from "../../../types/cli";
+import type { Report } from ".";
+interface SSMParameterReadinessOutput {
+    missingParameters: SsmParameterPath[];
+    foundParameters: SsmParameterPath[];
+    defaultVPCReferences: SsmParameterPath[];
+}
+export declare const report: (props: AwsConfig) => Promise<Report>;
+export declare const isPass: (output: SSMParameterReadinessOutput) => boolean;
+export {};
+//# sourceMappingURL=ssm.d.ts.map

package/lib/bin/commands/account-readiness/ssm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssm.d.ts","sourceRoot":"","sources":["../../../../src/bin/commands/account-readiness/ssm.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAEhC,UAAU,2BAA2B;IACnC,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC,eAAe,EAAE,gBAAgB,EAAE,CAAC;IACpC,oBAAoB,EAAE,gBAAgB,EAAE,CAAC;CAC1C;AAgDD,eAAO,MAAM,MAAM,GAAU,OAAO,SAAS,KAAG,OAAO,CAAC,MAAM,CAgC7D,CAAC;AAEF,eAAO,MAAM,MAAM,GAAI,QAAQ,2BAA2B,KAAG,OAE5D,CAAC"}

package/lib/bin/commands/account-readiness/ssm.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPass = exports.report = void 0;
+const client_ec2_1 = require("@aws-sdk/client-ec2");
+const client_ssm_1 = require("@aws-sdk/client-ssm");
+const chalk_1 = __importDefault(require("chalk"));
+const constants_1 = require("../../../constants");
+const vpc_1 = require("../../../utils/cli/vpc");
+const ssmParamReadiness = async ({ credentialProvider, region }) => {
+    const ssmClient = new client_ssm_1.SSM({
+        credentials: credentialProvider,
+        region,
+    });
+    const ec2Client = new client_ec2_1.EC2({
+        credentials: credentialProvider,
+        region,
+    });
+    const ssmParams = constants_1.ALL_SSM_PARAMETER_PATHS.filter((param) => !param.optional);
+    const paths = ssmParams.map((param) => param.path);
+    const awsResponse = await ssmClient.getParameters({ Names: paths });
+    const notFoundParameters = awsResponse.InvalidParameters ?? [];
+    const notFoundInDetail = ssmParams.filter((_) => notFoundParameters.includes(_.path));
+    const foundInDetail = ssmParams.filter((_) => !notFoundParameters.includes(_.path));
+    const vpcs = await (0, vpc_1.getVpcsInDetail)(ec2Client);
+    const ssmParamsFromAccount = await (0, vpc_1.getSsmParametersForVpc)(ssmClient);
+    const defaultVpcs = vpcs
+        .filter((vpc) => vpc.IsDefault)
+        .map((vpc) => {
+        // Non-null-assertion, A VPC always has an ID, the type in CDK is odd!
+        return vpc.VpcId;
+    });
+    const ssmParametersMatchingDefaultVpc = ssmParamsFromAccount.filter(({ Value }) => Value && defaultVpcs.includes(Value));
+    const defaultVPCReferencePaths = ssmParametersMatchingDefaultVpc
+        .map((param) => {
+        return ssmParams.find((p) => p.path === param.Name);
+    })
+        .filter((p) => p !== undefined);
+    return {
+        foundParameters: foundInDetail,
+        missingParameters: notFoundInDetail,
+        defaultVPCReferences: defaultVPCReferencePaths,
+    };
+};
+const report = async (props) => {
+    const output = await ssmParamReadiness(props);
+    const isPass = output.missingParameters.length === 0 && output.defaultVPCReferences.length === 0;
+    const errs = new Map();
+    const parametersMsg = "CDK uses predefined SSM parameters within patterns and constructs. For example, the EC2 APP pattern uses a parameter to determine which Kinesis stream to forward logs to. Your CDK app may fail at runtime if these parameters do not exist.";
+    const missingParamsMsg = "Required parameters are missing";
+    const missingParams = output.missingParameters.map((p) => `  ${chalk_1.default.yellowBright(p.path)}: ${p.description}`);
+    if (output.missingParameters.length > 0) {
+        errs.set(missingParamsMsg, `\n${missingParams.join("\n")}`);
+    }
+    if (output.defaultVPCReferences.length > 0) {
+        errs.set("Default VPC referenced in VPC parameters", `you should use a custom VPC instead. Default VPC is referenced in paths: ${output.defaultVPCReferences
+            .map((vpc) => vpc.path)
+            .join(", ")}.`);
+    }
+    return {
+        name: "SSM Parameter Readiness",
+        isPass: isPass,
+        msg: parametersMsg,
+        errors: errs,
+        parametersFound: output.foundParameters.length,
+        parametersMissing: output.missingParameters.length,
+    };
+};
+exports.report = report;
+const isPass = (output) => {
+    return output.missingParameters.length === 0;
+};
+exports.isPass = isPass;
+//# sourceMappingURL=ssm.js.map

package/lib/bin/commands/account-readiness/ssm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssm.js","sourceRoot":"","sources":["../../../../src/bin/commands/account-readiness/ssm.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA0C;AAC1C,oDAA0C;AAC1C,kDAA0B;AAE1B,kDAA6D;AAE7D,gDAAiF;AASjF,MAAM,iBAAiB,GAAG,KAAK,EAAE,EAAE,kBAAkB,EAAE,MAAM,EAAa,EAAwC,EAAE;IAClH,MAAM,SAAS,GAAG,IAAI,gBAAG,CAAC;QACxB,WAAW,EAAE,kBAAkB;QAC/B,MAAM;KACP,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,gBAAG,CAAC;QACxB,WAAW,EAAE,kBAAkB;QAC/B,MAAM;KACP,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,mCAAuB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7E,MAAM,KAAK,GAAa,SAAS,CAAC,GAAG,CAAC,CAAC,KAAuB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE/E,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAEpE,MAAM,kBAAkB,GAAG,WAAW,CAAC,iBAAiB,IAAI,EAAE,CAAC;IAC/D,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACtF,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpF,MAAM,IAAI,GAAG,MAAM,IAAA,qBAAe,EAAC,SAAS,CAAC,CAAC;IAC9C,MAAM,oBAAoB,GAAG,MAAM,IAAA,4BAAsB,EAAC,SAAS,CAAC,CAAC;IACrE,MAAM,WAAW,GAAa,IAAI;SAC/B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;SAC9B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,sEAAsE;QACtE,OAAO,GAAG,CAAC,KAAM,CAAC;IACpB,CAAC,CAAC,CAAC;IAEL,MAAM,+BAA+B,GAAG,oBAAoB,CAAC,MAAM,CACjE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,IAAI,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CACpD,CAAC;IAEF,MAAM,wBAAwB,GAAG,+BAA+B;SAC7D,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;IAEzD,OAAO;QACL,eAAe,EAAE,aAAa;QAC9B,iBAAiB,EAAE,gBAAgB;QACnC,oBAAoB,EAAE,wBAAwB;KAC/C,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,MAAM,GAAG,KAAK,EAAE,KAAgB,EAAmB,EAAE;IAChE,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,oBAAoB,CAAC,MAAM,KAAK,CAAC,CAAC;IAEjG,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,MAAM,aAAa,GACjB,+OAA+O,CAAC;IAElP,MAAM,gBAAgB,GAAG,iCAAiC,CAAC;IAC3D,MAAM,aAAa,GAAG,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,eAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAE/G,IAAI,MAAM,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,MAAM,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,IAAI,CAAC,GAAG,CACN,0CAA0C,EAC1C,4EAA4E,MAAM,CAAC,oBAAoB;aACpG,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;aACtB,IAAI,CAAC,IAAI,CAAC,GAAG,CACjB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,EAAE,yBAAyB;QAC/B,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,aAAa;QAClB,MAAM,EAAE,IAAI;QACZ,eAAe,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM;QAC9C,iBAAiB,EAAE,MAAM,CAAC,iBAAiB,CAAC,MAAM;KACnD,CAAC;AACJ,CAAC,CAAC;AAhCW,QAAA,MAAM,UAgCjB;AAEK,MAAM,MAAM,GAAG,CAAC,MAAmC,EAAW,EAAE;IACrE,OAAO,MAAM,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,CAAC;AAC/C,CAAC,CAAC;AAFW,QAAA,MAAM,UAEjB","sourcesContent":["import { EC2 } from \"@aws-sdk/client-ec2\";\nimport { SSM } from \"@aws-sdk/client-ssm\";\nimport chalk from \"chalk\";\nimport type { SsmParameterPath } from \"../../../constants\";\nimport { ALL_SSM_PARAMETER_PATHS } from \"../../../constants\";\nimport type { AwsConfig } from \"../../../types/cli\";\nimport { getSsmParametersForVpc, getVpcsInDetail } from \"../../../utils/cli/vpc\";\nimport type { Report } from \".\";\n\ninterface SSMParameterReadinessOutput {\n  missingParameters: SsmParameterPath[];\n  foundParameters: SsmParameterPath[];\n  defaultVPCReferences: SsmParameterPath[];\n}\n\nconst ssmParamReadiness = async ({ credentialProvider, region }: AwsConfig): Promise<SSMParameterReadinessOutput> => {\n  const ssmClient = new SSM({\n    credentials: credentialProvider,\n    region,\n  });\n\n  const ec2Client = new EC2({\n    credentials: credentialProvider,\n    region,\n  });\n\n  const ssmParams = ALL_SSM_PARAMETER_PATHS.filter((param) => !param.optional);\n  const paths: string[] = ssmParams.map((param: SsmParameterPath) => param.path);\n\n  const awsResponse = await ssmClient.getParameters({ Names: paths });\n\n  const notFoundParameters = awsResponse.InvalidParameters ?? [];\n  const notFoundInDetail = ssmParams.filter((_) => notFoundParameters.includes(_.path));\n  const foundInDetail = ssmParams.filter((_) => !notFoundParameters.includes(_.path));\n\n  const vpcs = await getVpcsInDetail(ec2Client);\n  const ssmParamsFromAccount = await getSsmParametersForVpc(ssmClient);\n  const defaultVpcs: string[] = vpcs\n    .filter((vpc) => vpc.IsDefault)\n    .map((vpc) => {\n      // Non-null-assertion, A VPC always has an ID, the type in CDK is odd!\n      return vpc.VpcId!;\n    });\n\n  const ssmParametersMatchingDefaultVpc = ssmParamsFromAccount.filter(\n    ({ Value }) => Value && defaultVpcs.includes(Value),\n  );\n\n  const defaultVPCReferencePaths = ssmParametersMatchingDefaultVpc\n    .map((param) => {\n      return ssmParams.find((p) => p.path === param.Name);\n    })\n    .filter((p): p is SsmParameterPath => p !== undefined);\n\n  return {\n    foundParameters: foundInDetail,\n    missingParameters: notFoundInDetail,\n    defaultVPCReferences: defaultVPCReferencePaths,\n  };\n};\n\nexport const report = async (props: AwsConfig): Promise<Report> => {\n  const output = await ssmParamReadiness(props);\n  const isPass = output.missingParameters.length === 0 && output.defaultVPCReferences.length === 0;\n\n  const errs = new Map<string, string>();\n  const parametersMsg =\n    \"CDK uses predefined SSM parameters within patterns and constructs. For example, the EC2 APP pattern uses a parameter to determine which Kinesis stream to forward logs to. Your CDK app may fail at runtime if these parameters do not exist.\";\n\n  const missingParamsMsg = \"Required parameters are missing\";\n  const missingParams = output.missingParameters.map((p) => `  ${chalk.yellowBright(p.path)}: ${p.description}`);\n\n  if (output.missingParameters.length > 0) {\n    errs.set(missingParamsMsg, `\\n${missingParams.join(\"\\n\")}`);\n  }\n\n  if (output.defaultVPCReferences.length > 0) {\n    errs.set(\n      \"Default VPC referenced in VPC parameters\",\n      `you should use a custom VPC instead. Default VPC is referenced in paths: ${output.defaultVPCReferences\n        .map((vpc) => vpc.path)\n        .join(\", \")}.`,\n    );\n  }\n\n  return {\n    name: \"SSM Parameter Readiness\",\n    isPass: isPass,\n    msg: parametersMsg,\n    errors: errs,\n    parametersFound: output.foundParameters.length,\n    parametersMissing: output.missingParameters.length,\n  };\n};\n\nexport const isPass = (output: SSMParameterReadinessOutput): boolean => {\n  return output.missingParameters.length === 0;\n};\n"]}

package/lib/bin/commands/aws-cdk-version.d.ts

@@ -0,0 +1,3 @@
+import type { CliCommandResponse } from "../../types/cli";
+export declare const awsCdkVersionCommand: () => CliCommandResponse;
+//# sourceMappingURL=aws-cdk-version.d.ts.map

package/lib/bin/commands/aws-cdk-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-cdk-version.d.ts","sourceRoot":"","sources":["../../../src/bin/commands/aws-cdk-version.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE1D,eAAO,MAAM,oBAAoB,QAAO,kBAEvC,CAAC"}

package/lib/bin/commands/aws-cdk-version.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.awsCdkVersionCommand = void 0;
+const constants_1 = require("../../constants");
+const awsCdkVersionCommand = () => {
+    return Promise.resolve(constants_1.LibraryInfo.AWS_CDK_VERSION);
+};
+exports.awsCdkVersionCommand = awsCdkVersionCommand;
+//# sourceMappingURL=aws-cdk-version.js.map

package/lib/bin/commands/aws-cdk-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-cdk-version.js","sourceRoot":"","sources":["../../../src/bin/commands/aws-cdk-version.ts"],"names":[],"mappings":";;;AAAA,+CAA8C;AAGvC,MAAM,oBAAoB,GAAG,GAAuB,EAAE;IAC3D,OAAO,OAAO,CAAC,OAAO,CAAC,uBAAW,CAAC,eAAe,CAAC,CAAC;AACtD,CAAC,CAAC;AAFW,QAAA,oBAAoB,wBAE/B","sourcesContent":["import { LibraryInfo } from \"../../constants\";\nimport type { CliCommandResponse } from \"../../types/cli\";\n\nexport const awsCdkVersionCommand = (): CliCommandResponse => {\n  return Promise.resolve(LibraryInfo.AWS_CDK_VERSION);\n};\n"]}

package/lib/bin/commands/new-project/index.d.ts

@@ -0,0 +1,14 @@
+import type { CliCommandResponse } from "../../../types/cli";
+export type PackageManager = "npm" | "yarn";
+interface NewProjectProps {
+    init: boolean;
+    app: string;
+    stack: string;
+    stages: string[];
+    regions: string[];
+    yamlTemplateLocation?: string;
+    packageManager: PackageManager;
+}
+export declare const newCdkProject: (props: NewProjectProps) => CliCommandResponse;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/bin/commands/new-project/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/bin/commands/new-project/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAY7D,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,CAAC;AAE5C,UAAU,eAAe;IACvB,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,cAAc,EAAE,cAAc,CAAC;CAChC;AAuED,eAAO,MAAM,aAAa,GAAU,OAAO,eAAe,KAAG,kBA8E5D,CAAC"}

package/lib/bin/commands/new-project/index.js

@@ -0,0 +1,134 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newCdkProject = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const chalk_1 = __importDefault(require("chalk"));
+const exec_1 = require("../../../utils/exec");
+const git_1 = require("../../../utils/git");
+const string_1 = require("../../../utils/string");
+const app_1 = require("./utils/app");
+const imports_1 = require("./utils/imports");
+const init_1 = require("./utils/init");
+const snapshot_1 = require("./utils/snapshot");
+const stack_1 = require("./utils/stack");
+const utils_1 = require("./utils/utils");
+const checkPathExists = (path) => {
+    if (!(0, fs_1.existsSync)(path)) {
+        throw new Error(`File not found - ${path}`);
+    }
+};
+const checkPathDoesNotExist = (path) => {
+    if ((0, fs_1.existsSync)(path)) {
+        throw new Error(`There is already a file at - ${path}`);
+    }
+};
+function validateConfig(config) {
+    if (!config.init) {
+        checkPathExists(config.cdkDir);
+    }
+    checkPathDoesNotExist(config.appPath); // TODO: Update the app file if it already exists
+    checkPathDoesNotExist(config.stackPath);
+    if (config.yamlTemplateLocation) {
+        checkPathExists(config.yamlTemplateLocation);
+    }
+}
+function getConfig(props) {
+    const { init, app, stack, stages, regions, yamlTemplateLocation, packageManager } = props;
+    const rootDir = (0, git_1.gitRootOrCwd)();
+    const cdkDir = (0, path_1.join)(rootDir, "/cdk");
+    const appName = (0, string_1.toPascalCase)(app);
+    const kebabAppName = (0, string_1.toKebabCase)(appName);
+    const stackName = (0, string_1.toPascalCase)(stack);
+    const kebabStackName = (0, string_1.toKebabCase)(stackName);
+    const config = {
+        init,
+        yamlTemplateLocation,
+        stages,
+        regions,
+        cdkDir,
+        appName: {
+            kebab: kebabAppName,
+            pascal: appName,
+        },
+        appPath: `${cdkDir}/bin/${kebabAppName}.ts`,
+        stackName: {
+            kebab: kebabStackName,
+            pascal: stackName,
+        },
+        stackPath: `${cdkDir}/lib/${kebabAppName}.ts`,
+        testPath: `${cdkDir}/lib/${kebabAppName}.test.ts`,
+        packageManager,
+    };
+    validateConfig(config);
+    return config;
+}
+const newCdkProject = async (props) => {
+    console.log("Starting CDK generator");
+    const config = getConfig(props);
+    if (config.init) {
+        (0, init_1.buildDirectory)({ outputDir: config.cdkDir });
+    }
+    console.log(`New app ${config.appName.pascal} will be written to ${config.appPath}`);
+    console.log(`New stack ${config.stackName.pascal} will be written to ${config.stackPath}`);
+    // bin directory
+    await (0, app_1.constructApp)({
+        appName: config.appName,
+        outputFile: "cdk.ts",
+        outputDir: (0, path_1.dirname)(config.appPath),
+        stack: config.stackName,
+        imports: imports_1.Imports.newAppImports(config.appName),
+        stages: config.stages,
+        regions: config.regions,
+    });
+    // lib directory
+    await (0, stack_1.constructStack)({
+        imports: imports_1.Imports.newStackImports(!!config.yamlTemplateLocation),
+        appName: config.appName,
+        outputFile: (0, path_1.basename)(config.stackPath),
+        outputDir: (0, path_1.dirname)(config.stackPath),
+        yamlTemplateLocation: config.yamlTemplateLocation,
+    });
+    // lib directory
+    await (0, snapshot_1.constructTest)({
+        imports: imports_1.Imports.newTestImports(config.appName),
+        stackName: config.stackName,
+        appName: config.appName,
+        outputFile: (0, path_1.basename)(config.testPath),
+        outputDir: (0, path_1.dirname)(config.stackPath),
+    });
+    const commands = (0, utils_1.getCommands)(config.packageManager, config.cdkDir);
+    if (config.init) {
+        console.log(chalk_1.default.yellow("Installing dependencies. This may take a while..."));
+        await commands.installDependencies();
+        console.log(chalk_1.default.green("  ✅ Successfully installed dependencies"));
+    }
+    // Run `eslint --fix` on the generated files instead of trying to generate code that completely satisfies the linter.
+    // Each glob must be a separate argument: `execute` uses `spawn` with `shell: false`, so a single
+    // "lib/** bin/**" string would be treated as one (non-matching) pattern and silently fixed nothing.
+    await (0, exec_1.execute)("./node_modules/.bin/eslint", ["lib/**", "bin/**", "--no-error-on-unmatched-pattern", "--fix"], {
+        cwd: config.cdkDir,
+    });
+    console.log(chalk_1.default.yellow("Running lint check..."));
+    await commands.lint();
+    console.log(chalk_1.default.green("  ✅ Successfully passed lint check"));
+    console.log(chalk_1.default.yellow("Running tests..."));
+    await commands.test();
+    console.log(chalk_1.default.green("  ✅ Successfully passed tests"));
+    console.log(chalk_1.default.yellow("Running initial synthesis..."));
+    await commands.synth();
+    console.log(chalk_1.default.green("  ✅ Successfully synthesized CDK app"));
+    console.log(chalk_1.default.green("Success! Here's a summary of the created files:"));
+    const tree = await (0, exec_1.execute)("tree", ["-I", "node_modules|cdk.out"], {
+        cwd: config.cdkDir,
+    });
+    console.log(tree);
+    const docsUrl = "https://github.com/guardian/cdk/tree/main/docs";
+    console.log(chalk_1.default.green(`Please see the docs (${docsUrl}) for next steps.`));
+    return Promise.resolve(0);
+};
+exports.newCdkProject = newCdkProject;
+//# sourceMappingURL=index.js.map

package/lib/bin/commands/new-project/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/bin/commands/new-project/index.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAgC;AAChC,+BAA+C;AAC/C,kDAA0B;AAE1B,8CAA8C;AAC9C,4CAAkD;AAClD,kDAAkE;AAClE,qCAA2C;AAC3C,6CAA0C;AAC1C,uCAA8C;AAC9C,+CAAiD;AACjD,yCAA+C;AAE/C,yCAA4C;AAuB5C,MAAM,eAAe,GAAG,CAAC,IAAY,EAAQ,EAAE;IAC7C,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAAQ,EAAE;IACnD,IAAI,IAAA,eAAU,EAAC,IAAI,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC,CAAC;AAEF,SAAS,cAAc,CAAC,MAAwB;IAC9C,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACjB,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,iDAAiD;IACxF,qBAAqB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAExC,IAAI,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAChC,eAAe,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAsB;IACvC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAE1F,MAAM,OAAO,GAAG,IAAA,kBAAY,GAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAErC,MAAM,OAAO,GAAG,IAAA,qBAAY,EAAC,GAAG,CAAC,CAAC;IAClC,MAAM,YAAY,GAAG,IAAA,oBAAW,EAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,IAAA,qBAAY,EAAC,KAAK,CAAC,CAAC;IACtC,MAAM,cAAc,GAAG,IAAA,oBAAW,EAAC,SAAS,CAAC,CAAC;IAE9C,MAAM,MAAM,GAAqB;QAC/B,IAAI;QACJ,oBAAoB;QACpB,MAAM;QACN,OAAO;QACP,MAAM;QACN,OAAO,EAAE;YACP,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,OAAO;SAChB;QACD,OAAO,EAAE,GAAG,MAAM,QAAQ,YAAY,KAAK;QAC3C,SAAS,EAAE;YACT,KAAK,EAAE,cAAc;YACrB,MAAM,EAAE,SAAS;SAClB;QACD,SAAS,EAAE,GAAG,MAAM,QAAQ,YAAY,KAAK;QAC7C,QAAQ,EAAE,GAAG,MAAM,QAAQ,YAAY,UAAU;QACjD,cAAc;KACf,CAAC;IAEF,cAAc,CAAC,MAAM,CAAC,CAAC;IAEvB,OAAO,MAAM,CAAC;AAChB,CAAC;AAEM,MAAM,aAAa,GAAG,KAAK,EAAE,KAAsB,EAAsB,EAAE;IAChF,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IAEhC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,IAAA,qBAAc,EAAC,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,CAAC,OAAO,CAAC,MAAM,uBAAuB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IACrF,OAAO,CAAC,GAAG,CAAC,aAAa,MAAM,CAAC,SAAS,CAAC,MAAM,uBAAuB,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAE3F,gBAAgB;IAChB,MAAM,IAAA,kBAAY,EAAC;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,UAAU,EAAE,QAAQ;QACpB,SAAS,EAAE,IAAA,cAAO,EAAC,MAAM,CAAC,OAAO,CAAC;QAClC,KAAK,EAAE,MAAM,CAAC,SAAS;QACvB,OAAO,EAAE,iBAAO,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC;QAC9C,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAC,CAAC;IAEH,gBAAgB;IAChB,MAAM,IAAA,sBAAc,EAAC;QACnB,OAAO,EAAE,iBAAO,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,oBAAoB,CAAC;QAC/D,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,UAAU,EAAE,IAAA,eAAQ,EAAC,MAAM,CAAC,SAAS,CAAC;QACtC,SAAS,EAAE,IAAA,cAAO,EAAC,MAAM,CAAC,SAAS,CAAC;QACpC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;KAClD,CAAC,CAAC;IAEH,gBAAgB;IAChB,MAAM,IAAA,wBAAa,EAAC;QAClB,OAAO,EAAE,iBAAO,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC;QAC/C,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,UAAU,EAAE,IAAA,eAAQ,EAAC,MAAM,CAAC,QAAQ,CAAC;QACrC,SAAS,EAAE,IAAA,cAAO,EAAC,MAAM,CAAC,SAAS,CAAC;KACrC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAEnE,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,mDAAmD,CAAC,CAAC,CAAC;QAC/E,MAAM,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,qHAAqH;IACrH,iGAAiG;IACjG,oGAAoG;IACpG,MAAM,IAAA,cAAO,EAAC,4BAA4B,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,iCAAiC,EAAE,OAAO,CAAC,EAAE;QAC5G,GAAG,EAAE,MAAM,CAAC,MAAM;KACnB,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC,CAAC;IACnD,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACtB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC,CAAC;IAE/D,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC9C,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACtB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC;IAE1D,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAC1D,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IACvB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC,CAAC;IAEjE,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC,CAAC;IAC5E,MAAM,IAAI,GAAG,MAAM,IAAA,cAAO,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,sBAAsB,CAAC,EAAE;QACjE,GAAG,EAAE,MAAM,CAAC,MAAM;KACnB,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAElB,MAAM,OAAO,GAAG,gDAAgD,CAAC;IACjE,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,wBAAwB,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAE7E,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC5B,CAAC,CAAC;AA9EW,QAAA,aAAa,iBA8ExB","sourcesContent":["import { existsSync } from \"fs\";\nimport { basename, dirname, join } from \"path\";\nimport chalk from \"chalk\";\nimport type { CliCommandResponse } from \"../../../types/cli\";\nimport { execute } from \"../../../utils/exec\";\nimport { gitRootOrCwd } from \"../../../utils/git\";\nimport { toKebabCase, toPascalCase } from \"../../../utils/string\";\nimport { constructApp } from \"./utils/app\";\nimport { Imports } from \"./utils/imports\";\nimport { buildDirectory } from \"./utils/init\";\nimport { constructTest } from \"./utils/snapshot\";\nimport { constructStack } from \"./utils/stack\";\nimport type { Name } from \"./utils/utils\";\nimport { getCommands } from \"./utils/utils\";\n\nexport type PackageManager = \"npm\" | \"yarn\";\n\ninterface NewProjectProps {\n  init: boolean;\n  app: string;\n  stack: string;\n  stages: string[];\n  regions: string[];\n  yamlTemplateLocation?: string;\n  packageManager: PackageManager;\n}\n\ninterface NewProjectConfig extends Omit<NewProjectProps, \"stack\" | \"app\"> {\n  cdkDir: string;\n  appPath: string;\n  appName: Name;\n  stackPath: string;\n  stackName: Name;\n  testPath: string;\n}\n\nconst checkPathExists = (path: string): void => {\n  if (!existsSync(path)) {\n    throw new Error(`File not found - ${path}`);\n  }\n};\n\nconst checkPathDoesNotExist = (path: string): void => {\n  if (existsSync(path)) {\n    throw new Error(`There is already a file at - ${path}`);\n  }\n};\n\nfunction validateConfig(config: NewProjectConfig): void {\n  if (!config.init) {\n    checkPathExists(config.cdkDir);\n  }\n  checkPathDoesNotExist(config.appPath); // TODO: Update the app file if it already exists\n  checkPathDoesNotExist(config.stackPath);\n\n  if (config.yamlTemplateLocation) {\n    checkPathExists(config.yamlTemplateLocation);\n  }\n}\n\nfunction getConfig(props: NewProjectProps): NewProjectConfig {\n  const { init, app, stack, stages, regions, yamlTemplateLocation, packageManager } = props;\n\n  const rootDir = gitRootOrCwd();\n  const cdkDir = join(rootDir, \"/cdk\");\n\n  const appName = toPascalCase(app);\n  const kebabAppName = toKebabCase(appName);\n  const stackName = toPascalCase(stack);\n  const kebabStackName = toKebabCase(stackName);\n\n  const config: NewProjectConfig = {\n    init,\n    yamlTemplateLocation,\n    stages,\n    regions,\n    cdkDir,\n    appName: {\n      kebab: kebabAppName,\n      pascal: appName,\n    },\n    appPath: `${cdkDir}/bin/${kebabAppName}.ts`,\n    stackName: {\n      kebab: kebabStackName,\n      pascal: stackName,\n    },\n    stackPath: `${cdkDir}/lib/${kebabAppName}.ts`,\n    testPath: `${cdkDir}/lib/${kebabAppName}.test.ts`,\n    packageManager,\n  };\n\n  validateConfig(config);\n\n  return config;\n}\n\nexport const newCdkProject = async (props: NewProjectProps): CliCommandResponse => {\n  console.log(\"Starting CDK generator\");\n\n  const config = getConfig(props);\n\n  if (config.init) {\n    buildDirectory({ outputDir: config.cdkDir });\n  }\n\n  console.log(`New app ${config.appName.pascal} will be written to ${config.appPath}`);\n  console.log(`New stack ${config.stackName.pascal} will be written to ${config.stackPath}`);\n\n  // bin directory\n  await constructApp({\n    appName: config.appName,\n    outputFile: \"cdk.ts\",\n    outputDir: dirname(config.appPath),\n    stack: config.stackName,\n    imports: Imports.newAppImports(config.appName),\n    stages: config.stages,\n    regions: config.regions,\n  });\n\n  // lib directory\n  await constructStack({\n    imports: Imports.newStackImports(!!config.yamlTemplateLocation),\n    appName: config.appName,\n    outputFile: basename(config.stackPath),\n    outputDir: dirname(config.stackPath),\n    yamlTemplateLocation: config.yamlTemplateLocation,\n  });\n\n  // lib directory\n  await constructTest({\n    imports: Imports.newTestImports(config.appName),\n    stackName: config.stackName,\n    appName: config.appName,\n    outputFile: basename(config.testPath),\n    outputDir: dirname(config.stackPath),\n  });\n\n  const commands = getCommands(config.packageManager, config.cdkDir);\n\n  if (config.init) {\n    console.log(chalk.yellow(\"Installing dependencies. This may take a while...\"));\n    await commands.installDependencies();\n    console.log(chalk.green(\"  ✅ Successfully installed dependencies\"));\n  }\n\n  // Run `eslint --fix` on the generated files instead of trying to generate code that completely satisfies the linter.\n  // Each glob must be a separate argument: `execute` uses `spawn` with `shell: false`, so a single\n  // \"lib/** bin/**\" string would be treated as one (non-matching) pattern and silently fixed nothing.\n  await execute(\"./node_modules/.bin/eslint\", [\"lib/**\", \"bin/**\", \"--no-error-on-unmatched-pattern\", \"--fix\"], {\n    cwd: config.cdkDir,\n  });\n\n  console.log(chalk.yellow(\"Running lint check...\"));\n  await commands.lint();\n  console.log(chalk.green(\"  ✅ Successfully passed lint check\"));\n\n  console.log(chalk.yellow(\"Running tests...\"));\n  await commands.test();\n  console.log(chalk.green(\"  ✅ Successfully passed tests\"));\n\n  console.log(chalk.yellow(\"Running initial synthesis...\"));\n  await commands.synth();\n  console.log(chalk.green(\"  ✅ Successfully synthesized CDK app\"));\n\n  console.log(chalk.green(\"Success! Here's a summary of the created files:\"));\n  const tree = await execute(\"tree\", [\"-I\", \"node_modules|cdk.out\"], {\n    cwd: config.cdkDir,\n  });\n  console.log(tree);\n\n  const docsUrl = \"https://github.com/guardian/cdk/tree/main/docs\";\n  console.log(chalk.green(`Please see the docs (${docsUrl}) for next steps.`));\n\n  return Promise.resolve(0);\n};\n"]}

package/lib/bin/commands/new-project/template/.gitignore.template

@@ -0,0 +1,11 @@
+*.js
+!jest.config.js
+!jest.setup.js
+!.eslintrc.js
+*.d.ts
+node_modules
+dist
+
+# CDK asset staging directory
+.cdk.staging
+cdk.out

package/lib/bin/commands/new-project/template/README.md

@@ -0,0 +1,5 @@
+# Infrastructure
+
+This directory defines the components to be deployed to AWS.
+
+See [`package.json`](./package.json) for a list of available scripts.

package/lib/bin/commands/new-project/template/bin/.ignore

@@ -0,0 +1,2 @@
+This file exists to ensure that the empty directory remains version controlled
+It is ignored by the `init` command when generating files

package/lib/bin/commands/new-project/template/cdk.json

@@ -0,0 +1,7 @@
+{
+  "app": "npx ts-node bin/cdk.ts",
+  "context": {
+    "aws-cdk:enableDiffNoFail": "true",
+    "@aws-cdk/core:stackRelativeExports": "true"
+  }
+}

package/lib/bin/commands/new-project/template/eslint.config.mjs

@@ -0,0 +1,6 @@
+import guardian from '@guardian/eslint-config';
+
+export default [
+	...guardian.configs.recommended,
+	...guardian.configs.jest
+];

package/lib/bin/commands/new-project/template/jest.setup.js

@@ -0,0 +1,2 @@
+/* eslint-disable no-undef -- jest globals are missing due to guardian.recommended.jest eslint rules not covering jest.setup.js */
+jest.mock("@guardian/cdk/lib/constants/tracking-tag");