@codedazur/cdk-docker-cluster 1.1.1 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @codedazur/cdk-docker-cluster
 
+## 2.0.0
+
+### Major Changes
+
+- [`4f12708`](https://github.com/codedazur/toolkit/commit/4f12708f7b35ce7e96af62c10a6f637e347c3c69) Thanks [@thijsdaniels](https://github.com/thijsdaniels)! - Custom domain names with external DNS registry are now supported. A HostedZone will no longer be looked up and must be provided instead if needed.
+
+### Patch Changes
+
+- Updated dependencies [[`4f12708`](https://github.com/codedazur/toolkit/commit/4f12708f7b35ce7e96af62c10a6f637e347c3c69)]:
+  - @codedazur/cdk-site-distribution@2.0.0
+
+## 1.1.2
+
+### Patch Changes
+
+- [`2734c9d`](https://github.com/codedazur/toolkit/commit/2734c9d2f1a6fbdbae8e7d676b1e06437200df23) Thanks [@thijsdaniels](https://github.com/thijsdaniels)! - Props are now marked as readonly.
+
+- [`62b823b`](https://github.com/codedazur/toolkit/commit/62b823bfb366f0b7b037b0485aafe7084fe3743f) Thanks [@thijsdaniels](https://github.com/thijsdaniels)! - Following a CDK update, the cache policy and origin request policy are now created as constructs instead of using a simple object.
+
+- Updated dependencies [[`2734c9d`](https://github.com/codedazur/toolkit/commit/2734c9d2f1a6fbdbae8e7d676b1e06437200df23)]:
+  - @codedazur/cdk-site-distribution@1.0.2
+
 ## 1.1.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as aws_cdk_lib_aws_cloudfront from 'aws-cdk-lib/aws-cloudfront';
 import * as aws_cdk_lib_aws_ecs from 'aws-cdk-lib/aws-ecs';
 import { ContainerImage, Secret, ScalableTaskCount } from 'aws-cdk-lib/aws-ecs';
 import { SiteDistributionProps, SiteDistribution } from '@codedazur/cdk-site-distribution';
@@ -6,16 +7,17 @@ import { ApplicationLoadBalancedFargateServiceProps, ApplicationLoadBalancedFarg
 import { Construct } from 'constructs';
 
 interface DockerClusterProps {
-    source: string | SourceProps | ContainerImage;
-    service?: {
-        port?: number;
-        tasks?: number | AutoScalingConfig;
-        cpu?: ApplicationLoadBalancedFargateServiceProps["cpu"];
-        memory?: ApplicationLoadBalancedFargateServiceProps["memoryLimitMiB"];
-        environment?: Record<string, string>;
-        secrets?: Record<string, Secret>;
-    };
-    distribution?: Omit<SiteDistributionProps, "origin">;
+    readonly source: string | SourceProps | ContainerImage;
+    readonly service?: ServiceProps;
+    readonly distribution?: Omit<SiteDistributionProps, "origin">;
+}
+interface ServiceProps {
+    readonly port?: number;
+    readonly tasks?: number | AutoScalingConfig;
+    readonly cpu?: ApplicationLoadBalancedFargateServiceProps["cpu"];
+    readonly memory?: ApplicationLoadBalancedFargateServiceProps["memoryLimitMiB"];
+    readonly environment?: Record<string, string>;
+    readonly secrets?: Record<string, Secret>;
 }
 interface AutoScalingConfig {
     /**
@@ -52,11 +54,11 @@ interface AutoScalingConfig {
     };
 }
 interface SourceProps {
-    directory: string;
-    exclude?: string[];
-    file?: string;
-    arguments?: Record<string, string>;
-    secrets?: Record<string, string>;
+    readonly directory: string;
+    readonly exclude?: string[];
+    readonly file?: string;
+    readonly arguments?: Record<string, string>;
+    readonly secrets?: Record<string, string>;
 }
 /**
  * An Docker cluster on a load balanced Fargate service on EC2, using an image
@@ -76,7 +78,22 @@ declare class DockerCluster extends Construct {
     protected createService(): ApplicationLoadBalancedFargateService;
     protected createAutoScaling(service: ApplicationLoadBalancedFargateService): ScalableTaskCount | undefined;
     protected createSiteDistribution(): SiteDistribution;
+    /**
+     * The managed "UseOriginCacheControlHeaders-QueryStrings" cache policy, which
+     * is designed for use with an origin that sends Cache-Control headers with
+     * the object, which is recommended for use with an Application Load Balancer,
+     * and includes query strings in the cache key.
+     * @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-origin-cache-headers-query-strings
+     */
+    protected createCachePolicy(): aws_cdk_lib_aws_cloudfront.ICachePolicy;
+    /**
+     * The managed "AllViewer" origin request policy, which includes all values
+     * (query strings, headers, and cookies) in the viewer request, which is
+     * recommended for use with an Application Load Balancer endpoint.
+     * @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-all-viewer
+     */
+    protected createOriginRequestPolicy(): aws_cdk_lib_aws_cloudfront.IOriginRequestPolicy;
     protected getOutputDirectory(): string;
 }
 
-export { DockerCluster, type DockerClusterProps };
+export { DockerCluster, type DockerClusterProps, type ServiceProps };

package/dist/index.js

@@ -1,43 +1,29 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  DockerCluster: () => DockerCluster
-});
-module.exports = __toCommonJS(index_exports);
-
 // src/constructs/DockerCluster.ts
-var import_cdk_site_distribution = require("@codedazur/cdk-site-distribution");
-var import_aws_cdk_lib = require("aws-cdk-lib");
-var import_aws_cloudfront = require("aws-cdk-lib/aws-cloudfront");
-var import_aws_cloudfront_origins = require("aws-cdk-lib/aws-cloudfront-origins");
-var import_aws_ecr_assets = require("aws-cdk-lib/aws-ecr-assets");
-var import_aws_ecs = require("aws-cdk-lib/aws-ecs");
-var import_aws_ecs_patterns = require("aws-cdk-lib/aws-ecs-patterns");
-var import_constructs = require("constructs");
-var DockerCluster = class extends import_constructs.Construct {
+import {
+  SiteDistribution
+} from "@codedazur/cdk-site-distribution";
+import { App } from "aws-cdk-lib";
+import {
+  AllowedMethods,
+  CachePolicy,
+  OriginProtocolPolicy,
+  OriginRequestPolicy
+} from "aws-cdk-lib/aws-cloudfront";
+import { LoadBalancerV2Origin } from "aws-cdk-lib/aws-cloudfront-origins";
+import { Platform } from "aws-cdk-lib/aws-ecr-assets";
+import {
+  Cluster,
+  ContainerImage
+} from "aws-cdk-lib/aws-ecs";
+import {
+  ApplicationLoadBalancedFargateService
+} from "aws-cdk-lib/aws-ecs-patterns";
+import { Construct } from "constructs";
+var DockerCluster = class extends Construct {
   constructor(scope, id, props) {
     super(scope, id);
     this.props = props;
-    this.image = this.props.source instanceof import_aws_ecs.ContainerImage ? this.props.source : this.createImage(this.props.source);
+    this.image = this.props.source instanceof ContainerImage ? this.props.source : this.createImage(this.props.source);
     this.service = this.createService();
     this.autoScaling = this.createAutoScaling(this.service);
     this.siteDistribution = this.createSiteDistribution();
@@ -45,14 +31,14 @@ var DockerCluster = class extends import_constructs.Construct {
   createImage(source) {
     const props = {
       exclude: [`**/${this.getOutputDirectory()}`],
-      platform: import_aws_ecr_assets.Platform.LINUX_AMD64
+      platform: Platform.LINUX_AMD64
       // networkMode: NetworkMode.HOST, // @todo Use the host network mode.
       // cacheFrom: [], // @todo Use the previously built image as a cache.
     };
     if (typeof source === "string") {
-      return import_aws_ecs.ContainerImage.fromAsset(source, props);
+      return ContainerImage.fromAsset(source, props);
     }
-    return import_aws_ecs.ContainerImage.fromAsset(source.directory, {
+    return ContainerImage.fromAsset(source.directory, {
       ...props,
       file: source.file,
       buildArgs: source.arguments,
@@ -61,8 +47,8 @@ var DockerCluster = class extends import_constructs.Construct {
   }
   createService() {
     const desiredTasks = typeof this.props.service?.tasks === "number" ? this.props.service?.tasks : this.props.service?.tasks?.minimum;
-    const service = new import_aws_ecs_patterns.ApplicationLoadBalancedFargateService(this, "Service", {
-      cluster: new import_aws_ecs.Cluster(this, "Cluster"),
+    const service = new ApplicationLoadBalancedFargateService(this, "Service", {
+      cluster: new Cluster(this, "Cluster"),
       cpu: this.props.service?.cpu,
       memoryLimitMiB: this.props.service?.memory,
       desiredCount: desiredTasks,
@@ -100,40 +86,48 @@ var DockerCluster = class extends import_constructs.Construct {
     return autoScaling;
   }
   createSiteDistribution() {
-    return new import_cdk_site_distribution.SiteDistribution(this, "Distribution", {
-      allowedMethods: import_aws_cloudfront.AllowedMethods.ALLOW_ALL,
-      cachePolicy: {
-        /**
-         * The managed "UseOriginCacheControlHeaders-QueryStrings" cache policy,
-         * which is designed for use with an origin that sends Cache-Control
-         * headers with the object, which is recommended for use with an
-         * Application Load Balancer, and includes query strings in the cache
-         * key.
-         * @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-origin-cache-headers-query-strings
-         */
-        cachePolicyId: "4cc15a8a-d715-48a4-82b8-cc0b614638fe"
-      },
-      originRequestPolicy: {
-        /**
-         * The managed "AllViewer" origin request policy, which includes all
-         * values (query strings, headers, and cookies) in the viewer request,
-         * which is recommended for use with an Application Load Balancer
-         * endpoint.
-         * @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-all-viewer
-         */
-        originRequestPolicyId: "216adef6-5c7f-47e4-b989-5492eafa07d3"
-      },
-      ...this.props.distribution,
-      origin: new import_aws_cloudfront_origins.LoadBalancerV2Origin(this.service.loadBalancer, {
-        protocolPolicy: import_aws_cloudfront.OriginProtocolPolicy.HTTP_ONLY
+    const { cachePolicy, originRequestPolicy, ...distribution } = this.props.distribution ?? {};
+    return new SiteDistribution(this, "Distribution", {
+      allowedMethods: AllowedMethods.ALLOW_ALL,
+      cachePolicy: cachePolicy ?? this.createCachePolicy(),
+      originRequestPolicy: originRequestPolicy ?? this.createOriginRequestPolicy(),
+      ...distribution,
+      origin: new LoadBalancerV2Origin(this.service.loadBalancer, {
+        protocolPolicy: OriginProtocolPolicy.HTTP_ONLY
       })
     });
   }
+  /**
+   * The managed "UseOriginCacheControlHeaders-QueryStrings" cache policy, which
+   * is designed for use with an origin that sends Cache-Control headers with
+   * the object, which is recommended for use with an Application Load Balancer,
+   * and includes query strings in the cache key.
+   * @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-origin-cache-headers-query-strings
+   */
+  createCachePolicy() {
+    return CachePolicy.fromCachePolicyId(
+      this,
+      "CachePolicy",
+      "4cc15a8a-d715-48a4-82b8-cc0b614638fe" /* UseOriginCacheControlHeadersQueryStrings */
+    );
+  }
+  /**
+   * The managed "AllViewer" origin request policy, which includes all values
+   * (query strings, headers, and cookies) in the viewer request, which is
+   * recommended for use with an Application Load Balancer endpoint.
+   * @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-all-viewer
+   */
+  createOriginRequestPolicy() {
+    return OriginRequestPolicy.fromOriginRequestPolicyId(
+      this,
+      "OriginRequestPolicy",
+      "216adef6-5c7f-47e4-b989-5492eafa07d3" /* AllViewer */
+    );
+  }
   getOutputDirectory() {
-    return import_aws_cdk_lib.App.of(this)?.outdir ?? "cdk.out";
+    return App.of(this)?.outdir ?? "cdk.out";
   }
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   DockerCluster
-});
+};

package/eslint.config.ts

@@ -0,0 +1,6 @@
+import { distribution } from "@codedazur/eslint-config";
+import { cdk } from "@codedazur/eslint-config/cdk";
+import { defineConfig } from "eslint/config";
+import root from "../../eslint.config";
+
+export default defineConfig(root, cdk, distribution);

package/package.json

@@ -1,25 +1,20 @@
 {
   "name": "@codedazur/cdk-docker-cluster",
-  "version": "1.1.1",
-  "main": ".dist/index.js",
-  "module": "./dist/index.mjs",
+  "version": "2.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs"
-    }
-  },
+  "exports": "./dist/index.js",
   "publishConfig": {
     "access": "public"
   },
   "license": "MIT",
   "sideEffects": false,
   "scripts": {
-    "develop": "tsup src/index.ts --format esm,cjs --dts --watch",
-    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "develop": "tsup src/index.ts --clean --format esm --dts --watch",
+    "build": "tsup src/index.ts --clean --format esm --dts",
     "audit": "npm audit --omit dev --audit-level high",
-    "lint": "TIMING=1 eslint \"**/*.ts*\"",
+    "lint": "eslint .",
     "types": "tsc --noEmit",
     "test": "vitest run --passWithNoTests"
   },
@@ -28,12 +23,12 @@
     "constructs": ">=10"
   },
   "dependencies": {
-    "@codedazur/cdk-site-distribution": "^1.0.1"
+    "@codedazur/cdk-site-distribution": "^2.0.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.3",
-    "aws-cdk-lib": "^2.201.0",
-    "constructs": "^10.4.2",
-    "esbuild": "^0.25.5"
+    "@types/node": "^25.0.9",
+    "aws-cdk-lib": "^2.235.1",
+    "constructs": "^10.4.5",
+    "esbuild": "^0.27.2"
   }
 }

package/dist/index.d.mts

@@ -1,82 +0,0 @@
-import * as aws_cdk_lib_aws_ecs from 'aws-cdk-lib/aws-ecs';
-import { ContainerImage, Secret, ScalableTaskCount } from 'aws-cdk-lib/aws-ecs';
-import { SiteDistributionProps, SiteDistribution } from '@codedazur/cdk-site-distribution';
-import { Duration } from 'aws-cdk-lib';
-import { ApplicationLoadBalancedFargateServiceProps, ApplicationLoadBalancedFargateService } from 'aws-cdk-lib/aws-ecs-patterns';
-import { Construct } from 'constructs';
-
-interface DockerClusterProps {
-    source: string | SourceProps | ContainerImage;
-    service?: {
-        port?: number;
-        tasks?: number | AutoScalingConfig;
-        cpu?: ApplicationLoadBalancedFargateServiceProps["cpu"];
-        memory?: ApplicationLoadBalancedFargateServiceProps["memoryLimitMiB"];
-        environment?: Record<string, string>;
-        secrets?: Record<string, Secret>;
-    };
-    distribution?: Omit<SiteDistributionProps, "origin">;
-}
-interface AutoScalingConfig {
-    /**
-     * The minimum number of tasks to scale out to.
-     */
-    minimum: number;
-    /**
-     * The maximum number of tasks to scale out to.
-     */
-    maximum: number;
-    threshold?: {
-        /**
-         * The memory utilization percentage above which the service will scale out.
-         * @default 75
-         */
-        memory?: number;
-        /**
-         * The CPU utilization percentage above which the service will scale out.
-         * @default 75
-         */
-        cpu?: number;
-    };
-    cooldown?: {
-        /**
-         * The cooldown period for scaling in.
-         * @default Duration.seconds(300)
-         */
-        in?: Duration;
-        /**
-         * The cooldown period for scaling out.
-         * @default Duration.seconds(300)
-         */
-        out?: Duration;
-    };
-}
-interface SourceProps {
-    directory: string;
-    exclude?: string[];
-    file?: string;
-    arguments?: Record<string, string>;
-    secrets?: Record<string, string>;
-}
-/**
- * An Docker cluster on a load balanced Fargate service on EC2, using an image
- * built from a Dockerfile in a directory and pushed to ECR.
- * @todo Make the distribution and load balancer optional, to reduce cost and
- * increase deployment speed for development environments.
- */
-declare class DockerCluster extends Construct {
-    protected readonly props: DockerClusterProps;
-    readonly domain?: string;
-    readonly image: ContainerImage;
-    readonly service: ApplicationLoadBalancedFargateService;
-    readonly autoScaling?: ScalableTaskCount;
-    readonly siteDistribution: SiteDistribution;
-    constructor(scope: Construct, id: string, props: DockerClusterProps);
-    protected createImage(source: string | SourceProps): aws_cdk_lib_aws_ecs.AssetImage;
-    protected createService(): ApplicationLoadBalancedFargateService;
-    protected createAutoScaling(service: ApplicationLoadBalancedFargateService): ScalableTaskCount | undefined;
-    protected createSiteDistribution(): SiteDistribution;
-    protected getOutputDirectory(): string;
-}
-
-export { DockerCluster, type DockerClusterProps };

package/dist/index.mjs

@@ -1,122 +0,0 @@
-// src/constructs/DockerCluster.ts
-import {
-  SiteDistribution
-} from "@codedazur/cdk-site-distribution";
-import { App } from "aws-cdk-lib";
-import {
-  AllowedMethods,
-  OriginProtocolPolicy
-} from "aws-cdk-lib/aws-cloudfront";
-import { LoadBalancerV2Origin } from "aws-cdk-lib/aws-cloudfront-origins";
-import { Platform } from "aws-cdk-lib/aws-ecr-assets";
-import {
-  Cluster,
-  ContainerImage
-} from "aws-cdk-lib/aws-ecs";
-import {
-  ApplicationLoadBalancedFargateService
-} from "aws-cdk-lib/aws-ecs-patterns";
-import { Construct } from "constructs";
-var DockerCluster = class extends Construct {
-  constructor(scope, id, props) {
-    super(scope, id);
-    this.props = props;
-    this.image = this.props.source instanceof ContainerImage ? this.props.source : this.createImage(this.props.source);
-    this.service = this.createService();
-    this.autoScaling = this.createAutoScaling(this.service);
-    this.siteDistribution = this.createSiteDistribution();
-  }
-  createImage(source) {
-    const props = {
-      exclude: [`**/${this.getOutputDirectory()}`],
-      platform: Platform.LINUX_AMD64
-      // networkMode: NetworkMode.HOST, // @todo Use the host network mode.
-      // cacheFrom: [], // @todo Use the previously built image as a cache.
-    };
-    if (typeof source === "string") {
-      return ContainerImage.fromAsset(source, props);
-    }
-    return ContainerImage.fromAsset(source.directory, {
-      ...props,
-      file: source.file,
-      buildArgs: source.arguments,
-      buildSecrets: source.secrets
-    });
-  }
-  createService() {
-    const desiredTasks = typeof this.props.service?.tasks === "number" ? this.props.service?.tasks : this.props.service?.tasks?.minimum;
-    const service = new ApplicationLoadBalancedFargateService(this, "Service", {
-      cluster: new Cluster(this, "Cluster"),
-      cpu: this.props.service?.cpu,
-      memoryLimitMiB: this.props.service?.memory,
-      desiredCount: desiredTasks,
-      taskImageOptions: {
-        image: this.image,
-        containerPort: this.props.service?.port,
-        environment: this.props.service?.environment,
-        secrets: this.props.service?.secrets
-      },
-      circuitBreaker: {
-        enable: true,
-        rollback: true
-      }
-    });
-    return service;
-  }
-  createAutoScaling(service) {
-    if (typeof this.props.service?.tasks !== "object") {
-      return;
-    }
-    const autoScaling = service.service.autoScaleTaskCount({
-      minCapacity: this.props.service?.tasks.minimum,
-      maxCapacity: this.props.service?.tasks.maximum
-    });
-    autoScaling.scaleOnMemoryUtilization("MemoryScaling", {
-      targetUtilizationPercent: this.props.service?.tasks.threshold?.memory ?? 75,
-      scaleInCooldown: this.props.service?.tasks.cooldown?.in,
-      scaleOutCooldown: this.props.service?.tasks.cooldown?.out
-    });
-    autoScaling.scaleOnCpuUtilization("CpuScaling", {
-      targetUtilizationPercent: this.props.service?.tasks.threshold?.cpu ?? 75,
-      scaleInCooldown: this.props.service?.tasks.cooldown?.in,
-      scaleOutCooldown: this.props.service?.tasks.cooldown?.out
-    });
-    return autoScaling;
-  }
-  createSiteDistribution() {
-    return new SiteDistribution(this, "Distribution", {
-      allowedMethods: AllowedMethods.ALLOW_ALL,
-      cachePolicy: {
-        /**
-         * The managed "UseOriginCacheControlHeaders-QueryStrings" cache policy,
-         * which is designed for use with an origin that sends Cache-Control
-         * headers with the object, which is recommended for use with an
-         * Application Load Balancer, and includes query strings in the cache
-         * key.
-         * @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-origin-cache-headers-query-strings
-         */
-        cachePolicyId: "4cc15a8a-d715-48a4-82b8-cc0b614638fe"
-      },
-      originRequestPolicy: {
-        /**
-         * The managed "AllViewer" origin request policy, which includes all
-         * values (query strings, headers, and cookies) in the viewer request,
-         * which is recommended for use with an Application Load Balancer
-         * endpoint.
-         * @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-all-viewer
-         */
-        originRequestPolicyId: "216adef6-5c7f-47e4-b989-5492eafa07d3"
-      },
-      ...this.props.distribution,
-      origin: new LoadBalancerV2Origin(this.service.loadBalancer, {
-        protocolPolicy: OriginProtocolPolicy.HTTP_ONLY
-      })
-    });
-  }
-  getOutputDirectory() {
-    return App.of(this)?.outdir ?? "cdk.out";
-  }
-};
-export {
-  DockerCluster
-};