@gradientedge/cdk-utils 9.1.0 → 9.2.0

package/README.md

@@ -57,6 +57,28 @@ pnpm add @gradientedge/cdk-utils
 "@gradientedge/cdk-utils": "latest"
 ```
 
+## Testing
+
+To run test cases, use the following command:
+
+```shell
+pnpm run test
+```
+
+To focus on the test and watch when you make changes, use the following command:
+
+```shell
+pnpm test:watch static-asset-deployment-distribution-ref.test.ts
+```
+
+### Toolkit
+
+There are common utilities that help with testing constructs which you can find in the [test tools](./src/test/tools/cdk) directory.
+
+### Debug
+
+There is a debug utility that can be used to print out the contents of a `template`. This is useful for debugging and understanding the structure which you can find in the [debug](./src/test/tools/debug) directory.
+
 <!-- references -->
 
 [aws-cdk]: https://docs.aws.amazon.com/cdk/latest/guide/home.html

package/app/api-destined-function/node_modules/.bin/rimraf

@@ -6,9 +6,9 @@ case `uname` in
 esac
 
 if [ -z "$NODE_PATH" ]; then
-  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.5/node_modules/rimraf/dist/esm/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.5/node_modules/rimraf/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.5/node_modules/rimraf/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.5/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules"
+  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.7/node_modules/rimraf/dist/esm/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.7/node_modules/rimraf/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.7/node_modules/rimraf/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.7/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules"
 else
-  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.5/node_modules/rimraf/dist/esm/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.5/node_modules/rimraf/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.5/node_modules/rimraf/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.5/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules:$NODE_PATH"
+  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.7/node_modules/rimraf/dist/esm/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.7/node_modules/rimraf/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.7/node_modules/rimraf/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/rimraf@5.0.7/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules:$NODE_PATH"
 fi
 if [ -x "$basedir/node" ]; then
   exec "$basedir/node"  "$basedir/../rimraf/dist/esm/bin.mjs" "$@"

package/dist/src/lib/aws/common/stack.js

@@ -7,6 +7,7 @@ exports.CommonStack = void 0;
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const aws_lambda_1 = require("aws-cdk-lib/aws-lambda");
 const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 const construct_1 = require("./construct");
 const app_root_path_1 = __importDefault(require("app-root-path"));
 const lodash_1 = __importDefault(require("lodash"));
@@ -71,7 +72,7 @@ class CommonStack extends aws_cdk_lib_1.Stack {
             return;
         }
         lodash_1.default.forEach(extraContexts, (context) => {
-            const extraContextPath = `${app_root_path_1.default.path}/${context}`;
+            const extraContextPath = path_1.default.join(app_root_path_1.default.path, context);
             /* scenario where extra context is configured in cdk.json but absent in file system */
             if (!fs_1.default.existsSync(extraContextPath))
                 throw `Extra context properties unavailable in path:${extraContextPath}`;
@@ -95,7 +96,7 @@ class CommonStack extends aws_cdk_lib_1.Stack {
     determineStageContexts() {
         const stage = this.node.tryGetContext('stage');
         const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv';
-        const stageContextFilePath = `${app_root_path_1.default.path}/${stageContextPath}/${stage}.json`;
+        const stageContextFilePath = path_1.default.join(app_root_path_1.default.path, stageContextPath, `${stage}.json`);
         const debug = this.node.tryGetContext('debug');
         if ((0, common_1.isDevStage)(stage)) {
             if (debug)

package/dist/src/lib/aws/construct/static-asset-deployment/main.d.ts

@@ -1,4 +1,5 @@
 import { IBucket } from 'aws-cdk-lib/aws-s3';
+import { IDistribution } from 'aws-cdk-lib/aws-cloudfront';
 import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common';
 import { StaticAssetDeploymentProps } from './types';
@@ -11,16 +12,15 @@ import { StaticAssetDeploymentProps } from './types';
  * class CustomConstruct extends StaticAssetDeployment {
  *   constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps) {
  *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
  *     this.initResources()
  *   }
  * }
  */
 export declare class StaticAssetDeployment extends CommonConstruct {
+    staticAssetBucket: IBucket;
+    cloudfrontDistribution?: IDistribution;
     props: StaticAssetDeploymentProps;
     id: string;
-    staticAssetBucket: IBucket;
     constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps);
     /**
      * @summary Initialise and provision resources
@@ -30,6 +30,10 @@ export declare class StaticAssetDeployment extends CommonConstruct {
      * @summary Create the static asset bucket
      */
     protected createAssetBucket(): void;
+    /**
+     * @summary Distribute the load for the static asset bucket if both distribution and paths are provided
+     */
+    protected resolveDistribution(): void;
     /**
      * @summary Deploy the static assets into the static asset bucket
      */

package/dist/src/lib/aws/construct/static-asset-deployment/main.js

@@ -4,9 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StaticAssetDeployment = void 0;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
 const aws_s3_deployment_1 = require("aws-cdk-lib/aws-s3-deployment");
 const lodash_1 = __importDefault(require("lodash"));
 const common_1 = require("../../common");
+const app_root_path_1 = __importDefault(require("app-root-path"));
+const path_1 = __importDefault(require("path"));
 /**
  * @classdesc Provides a construct to create and deploy static assets into S3 bucket
  * @example
@@ -16,28 +19,27 @@ const common_1 = require("../../common");
  * class CustomConstruct extends StaticAssetDeployment {
  *   constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps) {
  *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
  *     this.initResources()
  *   }
  * }
  */
 class StaticAssetDeployment extends common_1.CommonConstruct {
-    /* construct properties */
-    props;
-    id;
     /* construct resources */
     staticAssetBucket;
+    cloudfrontDistribution;
+    props;
+    id;
     constructor(parent, id, props) {
         super(parent, id, props);
-        this.props = props;
         this.id = id;
+        this.props = props;
     }
     /**
      * @summary Initialise and provision resources
      */
     initResources() {
         this.createAssetBucket();
+        this.resolveDistribution();
         this.deployStaticAssets();
     }
     /**
@@ -46,14 +48,65 @@ class StaticAssetDeployment extends common_1.CommonConstruct {
     createAssetBucket() {
         this.staticAssetBucket = this.s3Manager.createS3Bucket(`${this.id}-sa-bucket`, this, this.props.staticAssetBucket);
     }
+    /**
+     * @summary Distribute the load for the static asset bucket if both distribution and paths are provided
+     */
+    resolveDistribution() {
+        if (this.props.cloudFrontDistribution &&
+            (this.props.cloudFrontDistribution.domainName || this.props.cloudFrontDistribution.domainNameRef) &&
+            (this.props.cloudFrontDistribution.distributionId || this.props.cloudFrontDistribution.distributionIdRef) &&
+            this.props.cloudFrontDistribution.invalidationPaths &&
+            this.props.cloudFrontDistribution.invalidationPaths.length > 0) {
+            let domainName = this.props.cloudFrontDistribution.domainName;
+            if (this.props.cloudFrontDistribution.domainNameRef) {
+                domainName = aws_cdk_lib_1.Fn.importValue(this.props.cloudFrontDistribution.domainNameRef);
+            }
+            let distributionId = this.props.cloudFrontDistribution.distributionId;
+            if (this.props.cloudFrontDistribution.distributionIdRef) {
+                distributionId = aws_cdk_lib_1.Fn.importValue(this.props.cloudFrontDistribution.distributionIdRef);
+            }
+            const distributionAttributes = {
+                domainName: domainName,
+                distributionId: distributionId,
+            };
+            this.cloudfrontDistribution = this.cloudFrontManager.resolveDistribution(this, distributionAttributes);
+        }
+    }
     /**
      * @summary Deploy the static assets into the static asset bucket
      */
     deployStaticAssets() {
+        let sources = [];
+        if (Array.isArray(this.props.staticAssetSources) &&
+            this.props.staticAssetSources.length > 0 &&
+            typeof this.props.staticAssetSources[0] === 'string') {
+            sources = this.props.staticAssetSources.map(source => {
+                const resolvedPath = path_1.default.join(app_root_path_1.default.path, source);
+                return aws_s3_deployment_1.Source.asset(resolvedPath);
+            });
+        }
+        else {
+            sources = this.props.staticAssetSources;
+        }
+        let distributionOptions = {};
+        if (this.cloudfrontDistribution) {
+            distributionOptions = {
+                distribution: this.cloudfrontDistribution,
+                distributionPaths: this.props.cloudFrontDistribution?.invalidationPaths,
+            };
+        }
+        let destinationKeyPrefixOptions = {};
+        if (this.props.destinationKeyPrefix) {
+            destinationKeyPrefixOptions = {
+                destinationKeyPrefix: this.props.destinationKeyPrefix,
+            };
+        }
         new aws_s3_deployment_1.BucketDeployment(this, `${this.id}-static-deployment`, {
             ...this.props.staticAssetDeployment,
             destinationBucket: this.staticAssetBucket,
-            sources: this.props.staticAssetSources,
+            sources: sources,
+            ...destinationKeyPrefixOptions,
+            ...distributionOptions,
         });
         const staticAssetsForExport = this.props.staticAssetsForExport;
         if (!staticAssetsForExport)

package/dist/src/lib/aws/construct/static-asset-deployment/types.d.ts

@@ -4,9 +4,38 @@ export interface AssetExport {
     key: string;
     value: string;
 }
+/**
+ * The CloudFront distribution to associate with the bucket.
+ * When value is configured, the construct will invalidate the distribution after the deployment.
+ * Use either domainName or distributionId or domainNameRef or distributionIdRef.
+ */
+export interface StaticCloudFrontDistribution {
+    /**
+     * @summary The domain name to associate with the bucket.
+     */
+    domainName?: string;
+    /**
+     * @summary The distribution ID to associate with the bucket.
+     */
+    distributionId?: string;
+    /**
+     * @summary The reference to domain name to associate with the bucket.
+     */
+    domainNameRef?: string;
+    /**
+     * @summary The reference to distribution ID to associate with the bucket.
+     */
+    distributionIdRef?: string;
+    /**
+     * @summary The paths to invalidate after deployment. Default is ['/*']
+     */
+    invalidationPaths: string[];
+}
 export interface StaticAssetDeploymentProps extends CommonStackProps {
     staticAssetBucket: S3BucketProps;
     staticAssetDeployment: BucketDeploymentProps;
-    staticAssetSources: any[];
+    staticAssetSources: any[] | string[];
     staticAssetsForExport?: AssetExport[];
+    destinationKeyPrefix?: string;
+    cloudFrontDistribution?: StaticCloudFrontDistribution;
 }

package/dist/src/lib/aws/services/cloudfront/main.d.ts

@@ -1,6 +1,6 @@
 import { ICertificate } from 'aws-cdk-lib/aws-certificatemanager';
 import * as cf from 'aws-cdk-lib/aws-cloudfront';
-import { FunctionAssociation, IResponseHeadersPolicy, OriginAccessIdentity } from 'aws-cdk-lib/aws-cloudfront';
+import { IDistribution, DistributionAttributes, FunctionAssociation, IResponseHeadersPolicy, OriginAccessIdentity } from 'aws-cdk-lib/aws-cloudfront';
 import { HttpOrigin, S3Origin } from 'aws-cdk-lib/aws-cloudfront-origins';
 import { ISecurityGroup, IVpc } from 'aws-cdk-lib/aws-ec2';
 import { IAccessPoint } from 'aws-cdk-lib/aws-efs';
@@ -105,4 +105,5 @@ export declare class CloudFrontManager {
      * @param props
      */
     createCloudfrontFunction(id: string, scope: CommonConstruct, props: CloudfrontFunctionProps): cf.Function;
+    resolveDistribution(scope: CommonConstruct, props: DistributionAttributes): IDistribution;
 }

package/dist/src/lib/aws/services/cloudfront/main.js

@@ -297,5 +297,8 @@ class CloudFrontManager {
         (0, utils_1.createCfnOutput)(`${id}-functionName`, scope, cloudfrontFunction.functionName);
         return cloudfrontFunction;
     }
+    resolveDistribution(scope, props) {
+        return aws_cloudfront_1.Distribution.fromDistributionAttributes(scope, `${scope.node.id}-sa-distribution`, props);
+    }
 }
 exports.CloudFrontManager = CloudFrontManager;

package/dist/src/lib/azure/common/stack.js

@@ -10,6 +10,7 @@ const app_root_path_1 = __importDefault(require("app-root-path"));
 const cdktf_1 = require("cdktf");
 const lodash_1 = __importDefault(require("lodash"));
 const common_1 = require("../../common");
+const path_1 = __importDefault(require("path"));
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
  * @example
@@ -66,7 +67,7 @@ class CommonAzureStack extends cdktf_1.TerraformStack {
             return;
         }
         lodash_1.default.forEach(extraContexts, (context) => {
-            const extraContextPath = `${app_root_path_1.default.path}/${context}`;
+            const extraContextPath = path_1.default.join(app_root_path_1.default.path, context);
             /* scenario where extra context is configured in cdk.json but absent in file system */
             if (!fs_1.default.existsSync(extraContextPath))
                 throw `Extra context properties unavailable in path:${extraContextPath}`;
@@ -90,7 +91,7 @@ class CommonAzureStack extends cdktf_1.TerraformStack {
     determineStageContexts() {
         const stage = this.node.tryGetContext('stage');
         const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv';
-        const stageContextFilePath = `${app_root_path_1.default.path}/${stageContextPath}/${stage}.json`;
+        const stageContextFilePath = path_1.default.join(app_root_path_1.default.path, stageContextPath, `${stage}.json`);
         const debug = this.node.tryGetContext('debug');
         if ((0, common_1.isDevStage)(stage)) {
             if (debug)

package/dist/src/lib/cloudflare/common/stack.js

@@ -9,6 +9,7 @@ const app_root_path_1 = __importDefault(require("app-root-path"));
 const cdktf_1 = require("cdktf");
 const lodash_1 = __importDefault(require("lodash"));
 const common_1 = require("../../common");
+const path_1 = __importDefault(require("path"));
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
  * @example
@@ -65,7 +66,7 @@ class CommonCloudflareStack extends cdktf_1.TerraformStack {
             return;
         }
         lodash_1.default.forEach(extraContexts, (context) => {
-            const extraContextPath = `${app_root_path_1.default.path}/${context}`;
+            const extraContextPath = path_1.default.join(app_root_path_1.default.path, context);
             /* scenario where extra context is configured in cdk.json but absent in file system */
             if (!fs_1.default.existsSync(extraContextPath))
                 throw `Extra context properties unavailable in path:${extraContextPath}`;
@@ -89,7 +90,7 @@ class CommonCloudflareStack extends cdktf_1.TerraformStack {
     determineStageContexts() {
         const stage = this.node.tryGetContext('stage');
         const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv';
-        const stageContextFilePath = `${app_root_path_1.default.path}/${stageContextPath}/${stage}.json`;
+        const stageContextFilePath = path_1.default.join(app_root_path_1.default.path, stageContextPath, `${stage}.json`);
         const debug = this.node.tryGetContext('debug');
         if ((0, common_1.isDevStage)(stage)) {
             if (debug)

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "9.1.0",
+  "version": "9.2.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
-    "node": ">=16 <=20"
+    "node": ">=16 <=20",
+    "pnpm": "=8"
   },
+  "packageManager": "pnpm@8.15.8",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gradientedge/cdk-utils.git"
@@ -38,6 +40,7 @@
     "prettier": "npx prettier --cache --check \"**/*.{ts,json,md}\"",
     "prettify": "npx prettier --cache --write \"**/*.{ts,json,md}\"",
     "test": "npx rimraf coverage && npx jest --ci --maxWorkers=100%",
+    "test:watch": "npx jest --coverage=false --watchAll",
     "update:deps": "ncu -u --deep --reject react,react-dom",
     "validate": "pnpm prettier && pnpm lint && pnpm test"
   },
@@ -57,7 +60,7 @@
     "@types/node": "^20.12.7",
     "@types/uuid": "^9.0.8",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.137.0",
+    "aws-cdk-lib": "^2.141.0",
     "cdktf": "^0.20.7",
     "cdktf-local-exec": "^0.5.13",
     "constructs": "^10.3.0",
@@ -101,7 +104,8 @@
     "taffydb": "^2.7.3",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
-    "typescript": "5.4.5"
+    "typescript": "5.4.5",
+    "yaml": "^2.4.2"
   },
   "optionalDependencies": {
     "prop-types": "^15.8.1",

package/src/lib/aws/common/stack.ts

@@ -1,6 +1,8 @@
 import { App, Stack, StackProps } from 'aws-cdk-lib'
 import { Runtime } from 'aws-cdk-lib/aws-lambda'
 import fs from 'fs'
+import path from 'path'
+
 import { CommonConstruct } from './construct'
 import { CommonStackProps } from './types'
 
@@ -77,7 +79,7 @@ export class CommonStack extends Stack {
     }
 
     _.forEach(extraContexts, (context: string) => {
-      const extraContextPath = `${appRoot.path}/${context}`
+      const extraContextPath = path.join(appRoot.path, context)
 
       /* scenario where extra context is configured in cdk.json but absent in file system */
       if (!fs.existsSync(extraContextPath)) throw `Extra context properties unavailable in path:${extraContextPath}`
@@ -104,7 +106,8 @@ export class CommonStack extends Stack {
   protected determineStageContexts() {
     const stage = this.node.tryGetContext('stage')
     const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv'
-    const stageContextFilePath = `${appRoot.path}/${stageContextPath}/${stage}.json`
+    const stageContextFilePath = path.join(appRoot.path, stageContextPath, `${stage}.json`)
+
     const debug = this.node.tryGetContext('debug')
 
     if (isDevStage(stage)) {

package/src/lib/aws/construct/static-asset-deployment/main.ts

@@ -1,9 +1,13 @@
+import { Fn } from 'aws-cdk-lib'
 import { IBucket } from 'aws-cdk-lib/aws-s3'
-import { BucketDeployment } from 'aws-cdk-lib/aws-s3-deployment'
+import { IDistribution, DistributionAttributes } from 'aws-cdk-lib/aws-cloudfront'
 import { Construct } from 'constructs'
+import { BucketDeployment, Source, BucketDeploymentProps, ISource } from 'aws-cdk-lib/aws-s3-deployment'
 import _ from 'lodash'
 import { CommonConstruct } from '../../common'
 import { StaticAssetDeploymentProps } from './types'
+import appRoot from 'app-root-path'
+import path from 'path'
 
 /**
  * @classdesc Provides a construct to create and deploy static assets into S3 bucket
@@ -14,31 +18,28 @@ import { StaticAssetDeploymentProps } from './types'
  * class CustomConstruct extends StaticAssetDeployment {
  *   constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps) {
  *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
  *     this.initResources()
  *   }
  * }
  */
 export class StaticAssetDeployment extends CommonConstruct {
-  /* construct properties */
-  props: StaticAssetDeploymentProps
-  id: string
-
   /* construct resources */
   staticAssetBucket: IBucket
+  cloudfrontDistribution?: IDistribution
+  props: StaticAssetDeploymentProps
+  id: string
 
   constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps) {
     super(parent, id, props)
-    this.props = props
     this.id = id
+    this.props = props
   }
-
   /**
    * @summary Initialise and provision resources
    */
   public initResources() {
     this.createAssetBucket()
+    this.resolveDistribution()
     this.deployStaticAssets()
   }
 
@@ -49,14 +50,74 @@ export class StaticAssetDeployment extends CommonConstruct {
     this.staticAssetBucket = this.s3Manager.createS3Bucket(`${this.id}-sa-bucket`, this, this.props.staticAssetBucket)
   }
 
+  /**
+   * @summary Distribute the load for the static asset bucket if both distribution and paths are provided
+   */
+  protected resolveDistribution() {
+    if (
+      this.props.cloudFrontDistribution &&
+      (this.props.cloudFrontDistribution.domainName || this.props.cloudFrontDistribution.domainNameRef) &&
+      (this.props.cloudFrontDistribution.distributionId || this.props.cloudFrontDistribution.distributionIdRef) &&
+      this.props.cloudFrontDistribution.invalidationPaths &&
+      this.props.cloudFrontDistribution.invalidationPaths.length > 0
+    ) {
+      let domainName = this.props.cloudFrontDistribution.domainName
+      if (this.props.cloudFrontDistribution.domainNameRef) {
+        domainName = Fn.importValue(this.props.cloudFrontDistribution.domainNameRef)
+      }
+      let distributionId = this.props.cloudFrontDistribution.distributionId
+      if (this.props.cloudFrontDistribution.distributionIdRef) {
+        distributionId = Fn.importValue(this.props.cloudFrontDistribution.distributionIdRef)
+      }
+
+      const distributionAttributes = {
+        domainName: domainName,
+        distributionId: distributionId,
+      } as any as DistributionAttributes
+
+      this.cloudfrontDistribution = this.cloudFrontManager.resolveDistribution(this, distributionAttributes)
+    }
+  }
+
   /**
    * @summary Deploy the static assets into the static asset bucket
    */
   protected deployStaticAssets() {
+    let sources: Array<ISource> = []
+    if (
+      Array.isArray(this.props.staticAssetSources) &&
+      this.props.staticAssetSources.length > 0 &&
+      typeof this.props.staticAssetSources[0] === 'string'
+    ) {
+      sources = this.props.staticAssetSources.map(source => {
+        const resolvedPath = path.join(appRoot.path, source)
+        return Source.asset(resolvedPath)
+      })
+    } else {
+      sources = this.props.staticAssetSources as ISource[]
+    }
+
+    let distributionOptions: Pick<BucketDeploymentProps, 'distribution' | 'distributionPaths'> = {}
+    if (this.cloudfrontDistribution) {
+      distributionOptions = {
+        distribution: this.cloudfrontDistribution,
+        distributionPaths: this.props.cloudFrontDistribution?.invalidationPaths,
+      }
+    }
+
+    let destinationKeyPrefixOptions = {}
+    if (this.props.destinationKeyPrefix) {
+      destinationKeyPrefixOptions = {
+        destinationKeyPrefix: this.props.destinationKeyPrefix,
+      }
+    }
+
     new BucketDeployment(this, `${this.id}-static-deployment`, {
       ...this.props.staticAssetDeployment,
       destinationBucket: this.staticAssetBucket,
-      sources: this.props.staticAssetSources,
+      sources: sources,
+      ...destinationKeyPrefixOptions,
+      ...distributionOptions,
     })
 
     const staticAssetsForExport = this.props.staticAssetsForExport

package/src/lib/aws/construct/static-asset-deployment/types.ts

@@ -6,9 +6,39 @@ export interface AssetExport {
   value: string
 }
 
+/**
+ * The CloudFront distribution to associate with the bucket.
+ * When value is configured, the construct will invalidate the distribution after the deployment.
+ * Use either domainName or distributionId or domainNameRef or distributionIdRef.
+ */
+export interface StaticCloudFrontDistribution {
+  /**
+   * @summary The domain name to associate with the bucket.
+   */
+  domainName?: string
+  /**
+   * @summary The distribution ID to associate with the bucket.
+   */
+  distributionId?: string
+  /**
+   * @summary The reference to domain name to associate with the bucket.
+   */
+  domainNameRef?: string
+  /**
+   * @summary The reference to distribution ID to associate with the bucket.
+   */
+  distributionIdRef?: string
+  /**
+   * @summary The paths to invalidate after deployment. Default is ['/*']
+   */
+  invalidationPaths: string[]
+}
+
 export interface StaticAssetDeploymentProps extends CommonStackProps {
   staticAssetBucket: S3BucketProps
   staticAssetDeployment: BucketDeploymentProps
-  staticAssetSources: any[]
+  staticAssetSources: any[] | string[]
   staticAssetsForExport?: AssetExport[]
+  destinationKeyPrefix?: string
+  cloudFrontDistribution?: StaticCloudFrontDistribution
 }

package/src/lib/aws/services/cloudfront/main.ts

@@ -2,6 +2,8 @@ import { Duration, Tags } from 'aws-cdk-lib'
 import { ICertificate } from 'aws-cdk-lib/aws-certificatemanager'
 import * as cf from 'aws-cdk-lib/aws-cloudfront'
 import {
+  IDistribution,
+  DistributionAttributes,
   CloudFrontWebDistribution,
   Distribution,
   Function,
@@ -362,4 +364,8 @@ export class CloudFrontManager {
 
     return cloudfrontFunction
   }
+
+  public resolveDistribution(scope: CommonConstruct, props: DistributionAttributes): IDistribution {
+    return Distribution.fromDistributionAttributes(scope, `${scope.node.id}-sa-distribution`, props)
+  }
 }

package/src/lib/azure/common/stack.ts

@@ -7,6 +7,7 @@ import { TerraformStack } from 'cdktf'
 import { Construct } from 'constructs'
 import _ from 'lodash'
 import { isDevStage } from '../../common'
+import path from 'path'
 
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
@@ -72,7 +73,7 @@ export class CommonAzureStack extends TerraformStack {
     }
 
     _.forEach(extraContexts, (context: string) => {
-      const extraContextPath = `${appRoot.path}/${context}`
+      const extraContextPath = path.join(appRoot.path, context)
 
       /* scenario where extra context is configured in cdk.json but absent in file system */
       if (!fs.existsSync(extraContextPath)) throw `Extra context properties unavailable in path:${extraContextPath}`
@@ -99,7 +100,7 @@ export class CommonAzureStack extends TerraformStack {
   protected determineStageContexts() {
     const stage = this.node.tryGetContext('stage')
     const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv'
-    const stageContextFilePath = `${appRoot.path}/${stageContextPath}/${stage}.json`
+    const stageContextFilePath = path.join(appRoot.path, stageContextPath, `${stage}.json`)
     const debug = this.node.tryGetContext('debug')
 
     if (isDevStage(stage)) {

package/src/lib/cloudflare/common/stack.ts

@@ -7,7 +7,7 @@ import { TerraformStack } from 'cdktf'
 import { Construct } from 'constructs'
 import _ from 'lodash'
 import { isDevStage } from '../../common'
-import { RemoteBackend } from './constants'
+import path from 'path'
 
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
@@ -72,7 +72,7 @@ export class CommonCloudflareStack extends TerraformStack {
     }
 
     _.forEach(extraContexts, (context: string) => {
-      const extraContextPath = `${appRoot.path}/${context}`
+      const extraContextPath = path.join(appRoot.path, context)
 
       /* scenario where extra context is configured in cdk.json but absent in file system */
       if (!fs.existsSync(extraContextPath)) throw `Extra context properties unavailable in path:${extraContextPath}`
@@ -99,7 +99,7 @@ export class CommonCloudflareStack extends TerraformStack {
   protected determineStageContexts() {
     const stage = this.node.tryGetContext('stage')
     const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv'
-    const stageContextFilePath = `${appRoot.path}/${stageContextPath}/${stage}.json`
+    const stageContextFilePath = path.join(appRoot.path, stageContextPath, `${stage}.json`)
     const debug = this.node.tryGetContext('debug')
 
     if (isDevStage(stage)) {