@guardian/cdk 51.0.0 → 52.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@guardian/cdk",
   "description": "Generic Guardian flavoured AWS CDK components",
-  "version": "51.0.0",
+  "version": "52.0.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -22,7 +22,7 @@
     "test:dev": "jest --detectOpenHandles --runInBand --watch",
     "prepare": "tsc",
     "prepack": "cp -r src/bin/commands/new-project/template lib/bin/commands/new-project/template",
-    "release": "semantic-release",
+    "release": "npx changeset",
     "release:docs": "rm -rf target && typedoc && gh-pages -d target -u \"github-actions-bot <support+actions@github.com>\"",
     "serve:docs": "rm -rf target && typedoc && serve target",
     "cli:dev": "ts-node src/bin/index.ts"
@@ -32,13 +32,13 @@
     "@guardian/eslint-plugin-tsdoc-required": "^0.1.3",
     "@guardian/tsconfig": "^0.2.0",
     "@types/git-url-parse": "^9.0.1",
-    "@types/jest": "^29.5.5",
-    "@types/js-yaml": "^4.0.6",
-    "@types/lodash.camelcase": "^4.3.7",
-    "@types/lodash.kebabcase": "^4.1.7",
-    "@types/lodash.upperfirst": "^4.3.7",
-    "@types/node": "20.8.2",
-    "@types/yargs": "^17.0.26",
+    "@types/jest": "^29.5.6",
+    "@types/js-yaml": "^4.0.8",
+    "@types/lodash.camelcase": "^4.3.8",
+    "@types/lodash.kebabcase": "^4.1.8",
+    "@types/lodash.upperfirst": "^4.3.8",
+    "@types/node": "20.8.8",
+    "@types/yargs": "^17.0.28",
     "aws-cdk": "2.100.0",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.50.0",
@@ -46,19 +46,19 @@
     "gh-pages": "^6.0.0",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",
-    "semantic-release": "^22.0.5",
     "serve": "^14.2.1",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.25.1",
+    "typedoc": "^0.25.2",
     "typescript": "5.1.6"
   },
   "dependencies": {
+    "@changesets/cli": "^2.26.2",
     "@oclif/core": "2.15.0",
     "aws-cdk-lib": "2.100.0",
     "aws-sdk": "^2.1469.0",
     "chalk": "^4.1.2",
-    "codemaker": "^1.89.0",
+    "codemaker": "^1.91.0",
     "constructs": "10.3.0",
     "git-url-parse": "^13.1.0",
     "js-yaml": "^4.1.0",

package/lib/constructs/loadbalancing/elb.d.ts

@@ -1,91 +0,0 @@
-import { Duration } from "aws-cdk-lib";
-import { LoadBalancer, LoadBalancingProtocol } from "aws-cdk-lib/aws-elasticloadbalancing";
-import type { HealthCheck, LoadBalancerListener, LoadBalancerProps } from "aws-cdk-lib/aws-elasticloadbalancing";
-import type { AppIdentity, GuStack } from "../core";
-interface GuClassicLoadBalancerProps extends Omit<LoadBalancerProps, "healthCheck">, AppIdentity {
-    propertiesToOverride?: Record<string, unknown>;
-    healthCheck?: Partial<HealthCheck>;
-    /**
-     * If your CloudFormation does not define the Scheme of your Load Balancer, you must set this boolean to true to avoid
-     * resource [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-scheme).
-     * If a Load Balancer is replaced it is likely to lead to downtime.
-     */
-    removeScheme?: boolean;
-}
-declare const GuClassicLoadBalancer_base: {
-    new (...args: any[]): {
-        readonly idWithApp: string;
-    };
-} & typeof LoadBalancer;
-/**
- * **IMPORTANT**: This construct should **only** be used if you are migrating an existing stack and you need to retain the load balancer.
- * Please use [[`GuApplicationLoadBalancer`]] instead of [[`GuClassicLoadBalancer`]] wherever possible.
- *
- * By default, load balancers created via this construct will perform a healthcheck against `/healthcheck` on port 9000. All healthcheck
- * defaults can be overridden via the `healthcheck` prop.
- *
- * For example, to use `/test` for the healthcheck path use:
- *
- * ```typescript
- * new GuClassicLoadBalancer(stack, "ClassicLoadBalancer", {
- *     // other props
- *     healthCheck: {
- *       path: "/test",
- *     },
- *   });
- * ```
- * If you are running an application which only accepts traffic over HTTPs, consider using [[`GuHttpsClassicLoadBalancer`]]
- * to reduce the amount of boilerplate needed when configuring your load balancer.
- *
- * This resource is stateful.
- * @see https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md
- */
-export declare class GuClassicLoadBalancer extends GuClassicLoadBalancer_base {
-    static DefaultHealthCheck: {
-        port: number;
-        path: string;
-        protocol: LoadBalancingProtocol;
-        healthyThreshold: number;
-        unhealthyThreshold: number;
-        interval: Duration;
-        timeout: Duration;
-    };
-    constructor(scope: GuStack, id: string, props: GuClassicLoadBalancerProps);
-}
-interface GuHttpsClassicLoadBalancerProps extends Omit<GuClassicLoadBalancerProps, "listeners"> {
-    listener?: Partial<LoadBalancerListener>;
-}
-/**
- * **IMPORTANT**: This construct should **only** be used if you are migrating an existing stack and you need to retain the load balancer.
- * Please use [[`GuHttpsApplicationListener`]] instead of [[`GuHttpsClassicLoadBalancer`]] wherever possible.
- *
- * This construct creates a classic load balancer which accepts HTTPS traffic. It communicates with EC2 instances over port 9000
- * by default. This default can be overridden via the listener prop, for example:
- * ```typescript
- * new GuHttpsClassicLoadBalancer(stack, "HttpsClassicLoadBalancer", {
- *     // other props
- *     listener: {
- *       internalPort: 3000,
- *     },
- *   });
- * ```
- *
- * You can pass a certificate id to this construct via the listener interface, for example:
- * ```typescript
- * new GuHttpsClassicLoadBalancer(stack, "HttpsClassicLoadBalancer", {
- *     // other props
- *     listener: {
- *       sslCertificateId: "certificateId",
- *     },
- *   });
- * ```
- * If certificate id is omitted the library will create a Parameter which allows you to pass in a certificate ARN.
- *
- * For more details on migrating an existing load balancer and general load balancer defaults, see [[`GuClassicLoadBalancer`]].
- */
-export declare class GuHttpsClassicLoadBalancer extends GuClassicLoadBalancer {
-    static DefaultListener: LoadBalancerListener;
-    constructor(scope: GuStack, id: string, props: GuHttpsClassicLoadBalancerProps);
-}
-export {};
-//# sourceMappingURL=elb.d.ts.map

package/lib/constructs/loadbalancing/elb.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"elb.d.ts","sourceRoot":"","sources":["../../../src/constructs/loadbalancing/elb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC3F,OAAO,KAAK,EAEV,WAAW,EACX,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEpD,UAAU,0BAA2B,SAAQ,IAAI,CAAC,iBAAiB,EAAE,aAAa,CAAC,EAAE,WAAW;IAC9F,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/C,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;;;;;;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,qBAAsB,SAAQ,0BAAiC;IAC1E,MAAM,CAAC,kBAAkB;;;;;;;;MAQvB;gBAEU,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B;CAiB1E;AAED,UAAU,+BAAgC,SAAQ,IAAI,CAAC,0BAA0B,EAAE,WAAW,CAAC;IAC7F,QAAQ,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,0BAA2B,SAAQ,qBAAqB;IACnE,MAAM,CAAC,eAAe,EAAE,oBAAoB,CAK1C;gBAEU,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,+BAA+B;CAmB/E"}

package/lib/constructs/loadbalancing/elb.js

@@ -1,109 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GuHttpsClassicLoadBalancer = exports.GuClassicLoadBalancer = void 0;
-const aws_cdk_lib_1 = require("aws-cdk-lib");
-const aws_elasticloadbalancing_1 = require("aws-cdk-lib/aws-elasticloadbalancing");
-const app_aware_construct_1 = require("../../utils/mixin/app-aware-construct");
-const core_1 = require("../core");
-/**
- * **IMPORTANT**: This construct should **only** be used if you are migrating an existing stack and you need to retain the load balancer.
- * Please use [[`GuApplicationLoadBalancer`]] instead of [[`GuClassicLoadBalancer`]] wherever possible.
- *
- * By default, load balancers created via this construct will perform a healthcheck against `/healthcheck` on port 9000. All healthcheck
- * defaults can be overridden via the `healthcheck` prop.
- *
- * For example, to use `/test` for the healthcheck path use:
- *
- * ```typescript
- * new GuClassicLoadBalancer(stack, "ClassicLoadBalancer", {
- *     // other props
- *     healthCheck: {
- *       path: "/test",
- *     },
- *   });
- * ```
- * If you are running an application which only accepts traffic over HTTPs, consider using [[`GuHttpsClassicLoadBalancer`]]
- * to reduce the amount of boilerplate needed when configuring your load balancer.
- *
- * This resource is stateful.
- * @see https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md
- */
-class GuClassicLoadBalancer extends (0, app_aware_construct_1.GuAppAwareConstruct)(aws_elasticloadbalancing_1.LoadBalancer) {
-    constructor(scope, id, props) {
-        const mergedProps = {
-            ...props,
-            healthCheck: { ...GuClassicLoadBalancer.DefaultHealthCheck, ...props.healthCheck },
-        };
-        super(scope, id, mergedProps);
-        const cfnLb = this.node.defaultChild;
-        if (props.removeScheme) {
-            cfnLb.addPropertyDeletionOverride("Scheme");
-        }
-        mergedProps.propertiesToOverride &&
-            Object.entries(mergedProps.propertiesToOverride).forEach(([key, value]) => cfnLb.addPropertyOverride(key, value));
-    }
-}
-exports.GuClassicLoadBalancer = GuClassicLoadBalancer;
-GuClassicLoadBalancer.DefaultHealthCheck = {
-    port: 9000,
-    path: "/healthcheck",
-    protocol: aws_elasticloadbalancing_1.LoadBalancingProtocol.HTTP,
-    healthyThreshold: 2,
-    unhealthyThreshold: 5,
-    interval: aws_cdk_lib_1.Duration.seconds(30),
-    timeout: aws_cdk_lib_1.Duration.seconds(10),
-};
-/**
- * **IMPORTANT**: This construct should **only** be used if you are migrating an existing stack and you need to retain the load balancer.
- * Please use [[`GuHttpsApplicationListener`]] instead of [[`GuHttpsClassicLoadBalancer`]] wherever possible.
- *
- * This construct creates a classic load balancer which accepts HTTPS traffic. It communicates with EC2 instances over port 9000
- * by default. This default can be overridden via the listener prop, for example:
- * ```typescript
- * new GuHttpsClassicLoadBalancer(stack, "HttpsClassicLoadBalancer", {
- *     // other props
- *     listener: {
- *       internalPort: 3000,
- *     },
- *   });
- * ```
- *
- * You can pass a certificate id to this construct via the listener interface, for example:
- * ```typescript
- * new GuHttpsClassicLoadBalancer(stack, "HttpsClassicLoadBalancer", {
- *     // other props
- *     listener: {
- *       sslCertificateId: "certificateId",
- *     },
- *   });
- * ```
- * If certificate id is omitted the library will create a Parameter which allows you to pass in a certificate ARN.
- *
- * For more details on migrating an existing load balancer and general load balancer defaults, see [[`GuClassicLoadBalancer`]].
- */
-class GuHttpsClassicLoadBalancer extends GuClassicLoadBalancer {
-    constructor(scope, id, props) {
-        const listenerProps = { ...GuHttpsClassicLoadBalancer.DefaultListener, ...props.listener };
-        const mergedProps = {
-            ...props,
-            listeners: [
-                {
-                    ...listenerProps,
-                    sslCertificateArn: listenerProps.sslCertificateArn ??
-                        new core_1.GuArnParameter(scope, "CertificateARN", {
-                            description: "Certificate ARN for ELB",
-                        }).valueAsString,
-                },
-            ],
-        };
-        super(scope, id, mergedProps);
-    }
-}
-exports.GuHttpsClassicLoadBalancer = GuHttpsClassicLoadBalancer;
-GuHttpsClassicLoadBalancer.DefaultListener = {
-    internalPort: 9000,
-    externalPort: 443,
-    internalProtocol: aws_elasticloadbalancing_1.LoadBalancingProtocol.HTTP,
-    externalProtocol: aws_elasticloadbalancing_1.LoadBalancingProtocol.HTTPS,
-};
-//# sourceMappingURL=elb.js.map

package/lib/constructs/loadbalancing/elb.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"elb.js","sourceRoot":"","sources":["../../../src/constructs/loadbalancing/elb.ts"],"names":[],"mappings":";;;AAAA,6CAAuC;AACvC,mFAA2F;AAO3F,+EAA4E;AAC5E,kCAAyC;AAczC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,qBAAsB,SAAQ,IAAA,yCAAmB,EAAC,uCAAY,CAAC;IAW1E,YAAY,KAAc,EAAE,EAAU,EAAE,KAAiC;QACvE,MAAM,WAAW,GAAG;YAClB,GAAG,KAAK;YACR,WAAW,EAAE,EAAE,GAAG,qBAAqB,CAAC,kBAAkB,EAAE,GAAG,KAAK,CAAC,WAAW,EAAE;SACnF,CAAC;QAEF,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,WAAW,CAAC,CAAC;QAE9B,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,YAA+B,CAAC;QAExD,IAAI,KAAK,CAAC,YAAY,EAAE;YACtB,KAAK,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;SAC7C;QAED,WAAW,CAAC,oBAAoB;YAC9B,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IACtH,CAAC;;AA3BH,sDA4BC;AA3BQ,wCAAkB,GAAG;IAC1B,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,cAAc;IACpB,QAAQ,EAAE,gDAAqB,CAAC,IAAI;IACpC,gBAAgB,EAAE,CAAC;IACnB,kBAAkB,EAAE,CAAC;IACrB,QAAQ,EAAE,sBAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9B,OAAO,EAAE,sBAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;CAC9B,CAAC;AAyBJ;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,0BAA2B,SAAQ,qBAAqB;IAQnE,YAAY,KAAc,EAAE,EAAU,EAAE,KAAsC;QAC5E,MAAM,aAAa,GAAyB,EAAE,GAAG,0BAA0B,CAAC,eAAe,EAAE,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAEjH,MAAM,WAAW,GAA+B;YAC9C,GAAG,KAAK;YACR,SAAS,EAAE;gBACT;oBACE,GAAG,aAAa;oBAChB,iBAAiB,EACf,aAAa,CAAC,iBAAiB;wBAC/B,IAAI,qBAAc,CAAC,KAAK,EAAE,gBAAgB,EAAE;4BAC1C,WAAW,EAAE,yBAAyB;yBACvC,CAAC,CAAC,aAAa;iBACnB;aACF;SACF,CAAC;QAEF,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,WAAW,CAAC,CAAC;IAChC,CAAC;;AA1BH,gEA2BC;AA1BQ,0CAAe,GAAyB;IAC7C,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,GAAG;IACjB,gBAAgB,EAAE,gDAAqB,CAAC,IAAI;IAC5C,gBAAgB,EAAE,gDAAqB,CAAC,KAAK;CAC9C,CAAC","sourcesContent":["import { Duration } from \"aws-cdk-lib\";\nimport { LoadBalancer, LoadBalancingProtocol } from \"aws-cdk-lib/aws-elasticloadbalancing\";\nimport type {\n  CfnLoadBalancer,\n  HealthCheck,\n  LoadBalancerListener,\n  LoadBalancerProps,\n} from \"aws-cdk-lib/aws-elasticloadbalancing\";\nimport { GuAppAwareConstruct } from \"../../utils/mixin/app-aware-construct\";\nimport { GuArnParameter } from \"../core\";\nimport type { AppIdentity, GuStack } from \"../core\";\n\ninterface GuClassicLoadBalancerProps extends Omit<LoadBalancerProps, \"healthCheck\">, AppIdentity {\n  propertiesToOverride?: Record<string, unknown>;\n  healthCheck?: Partial<HealthCheck>;\n  /**\n   * If your CloudFormation does not define the Scheme of your Load Balancer, you must set this boolean to true to avoid\n   * resource [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-scheme).\n   * If a Load Balancer is replaced it is likely to lead to downtime.\n   */\n  removeScheme?: boolean;\n}\n\n/**\n * **IMPORTANT**: This construct should **only** be used if you are migrating an existing stack and you need to retain the load balancer.\n * Please use [[`GuApplicationLoadBalancer`]] instead of [[`GuClassicLoadBalancer`]] wherever possible.\n *\n * By default, load balancers created via this construct will perform a healthcheck against `/healthcheck` on port 9000. All healthcheck\n * defaults can be overridden via the `healthcheck` prop.\n *\n * For example, to use `/test` for the healthcheck path use:\n *\n * ```typescript\n * new GuClassicLoadBalancer(stack, \"ClassicLoadBalancer\", {\n *     // other props\n *     healthCheck: {\n *       path: \"/test\",\n *     },\n *   });\n * ```\n * If you are running an application which only accepts traffic over HTTPs, consider using [[`GuHttpsClassicLoadBalancer`]]\n * to reduce the amount of boilerplate needed when configuring your load balancer.\n *\n * This resource is stateful.\n * @see https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md\n */\nexport class GuClassicLoadBalancer extends GuAppAwareConstruct(LoadBalancer) {\n  static DefaultHealthCheck = {\n    port: 9000,\n    path: \"/healthcheck\",\n    protocol: LoadBalancingProtocol.HTTP,\n    healthyThreshold: 2,\n    unhealthyThreshold: 5,\n    interval: Duration.seconds(30),\n    timeout: Duration.seconds(10),\n  };\n\n  constructor(scope: GuStack, id: string, props: GuClassicLoadBalancerProps) {\n    const mergedProps = {\n      ...props,\n      healthCheck: { ...GuClassicLoadBalancer.DefaultHealthCheck, ...props.healthCheck },\n    };\n\n    super(scope, id, mergedProps);\n\n    const cfnLb = this.node.defaultChild as CfnLoadBalancer;\n\n    if (props.removeScheme) {\n      cfnLb.addPropertyDeletionOverride(\"Scheme\");\n    }\n\n    mergedProps.propertiesToOverride &&\n      Object.entries(mergedProps.propertiesToOverride).forEach(([key, value]) => cfnLb.addPropertyOverride(key, value));\n  }\n}\n\ninterface GuHttpsClassicLoadBalancerProps extends Omit<GuClassicLoadBalancerProps, \"listeners\"> {\n  listener?: Partial<LoadBalancerListener>;\n}\n\n/**\n * **IMPORTANT**: This construct should **only** be used if you are migrating an existing stack and you need to retain the load balancer.\n * Please use [[`GuHttpsApplicationListener`]] instead of [[`GuHttpsClassicLoadBalancer`]] wherever possible.\n *\n * This construct creates a classic load balancer which accepts HTTPS traffic. It communicates with EC2 instances over port 9000\n * by default. This default can be overridden via the listener prop, for example:\n * ```typescript\n * new GuHttpsClassicLoadBalancer(stack, \"HttpsClassicLoadBalancer\", {\n *     // other props\n *     listener: {\n *       internalPort: 3000,\n *     },\n *   });\n * ```\n *\n * You can pass a certificate id to this construct via the listener interface, for example:\n * ```typescript\n * new GuHttpsClassicLoadBalancer(stack, \"HttpsClassicLoadBalancer\", {\n *     // other props\n *     listener: {\n *       sslCertificateId: \"certificateId\",\n *     },\n *   });\n * ```\n * If certificate id is omitted the library will create a Parameter which allows you to pass in a certificate ARN.\n *\n * For more details on migrating an existing load balancer and general load balancer defaults, see [[`GuClassicLoadBalancer`]].\n */\nexport class GuHttpsClassicLoadBalancer extends GuClassicLoadBalancer {\n  static DefaultListener: LoadBalancerListener = {\n    internalPort: 9000,\n    externalPort: 443,\n    internalProtocol: LoadBalancingProtocol.HTTP,\n    externalProtocol: LoadBalancingProtocol.HTTPS,\n  };\n\n  constructor(scope: GuStack, id: string, props: GuHttpsClassicLoadBalancerProps) {\n    const listenerProps: LoadBalancerListener = { ...GuHttpsClassicLoadBalancer.DefaultListener, ...props.listener };\n\n    const mergedProps: GuClassicLoadBalancerProps = {\n      ...props,\n      listeners: [\n        {\n          ...listenerProps,\n          sslCertificateArn:\n            listenerProps.sslCertificateArn ??\n            new GuArnParameter(scope, \"CertificateARN\", {\n              description: \"Certificate ARN for ELB\",\n            }).valueAsString,\n        },\n      ],\n    };\n\n    super(scope, id, mergedProps);\n  }\n}\n"]}