@gradientedge/cdk-utils 8.135.0 → 8.137.0

package/dist/src/lib/cloudflare/services/zone/main.js

@@ -0,0 +1,188 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudflareZoneManager = void 0;
+const data_cloudflare_zone_1 = require("@cdktf/provider-cloudflare/lib/data-cloudflare-zone");
+const zone_1 = require("@cdktf/provider-cloudflare/lib/zone");
+const zone_cache_reserve_1 = require("@cdktf/provider-cloudflare/lib/zone-cache-reserve");
+const zone_cache_variants_1 = require("@cdktf/provider-cloudflare/lib/zone-cache-variants");
+const zone_dnssec_1 = require("@cdktf/provider-cloudflare/lib/zone-dnssec");
+const zone_hold_1 = require("@cdktf/provider-cloudflare/lib/zone-hold");
+const zone_lockdown_1 = require("@cdktf/provider-cloudflare/lib/zone-lockdown");
+const zone_settings_override_1 = require("@cdktf/provider-cloudflare/lib/zone-settings-override");
+const utils_1 = require("../../utils");
+/**
+ * @classdesc Provides operations on Cloudflare Zone
+ * - A new instance of this class is injected into {@link CommonCloudflareConstruct} constructor.
+ * - If a custom construct extends {@link CommonCloudflareConstruct}, an instance is available within the context.
+ * @example
+ * ```
+ * import { CommonCloudflareConstruct, CommonCloudflareConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonCloudflareConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonCloudflareStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.zoneManager.createZone('MyZone', this, props)
+ *   }
+ * }
+ * ```
+ */
+class CloudflareZoneManager {
+    /**
+     * @summary Method to create a new zone
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props zone properties
+     * @see [CDKTF Zone Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zone.typescript.md}
+     */
+    createZone(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const zone = new zone_1.Zone(scope, `${id}`, {
+            ...props,
+            accountId: props.accountId ?? scope.props.accountId,
+            zone: props.zone ?? scope.props.domainName,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneName`, scope, zone.zone);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneFriendlyUniqueId`, scope, zone.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneId`, scope, zone.id);
+        return zone;
+    }
+    resolveZone(id, scope, options) {
+        if (!options)
+            throw `Options undefined for ${id}`;
+        const zone = new data_cloudflare_zone_1.DataCloudflareZone(scope, `${id}-data-zone`, {
+            accountId: scope.props.accountId,
+            name: options.name ?? scope.props.domainName,
+            zoneId: options.id,
+        });
+        return zone;
+    }
+    /**
+     * @summary Method to create a new zone cache reserve
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props zone cache reserve properties
+     * @see [CDKTF Zone Cache Reserve Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zoneCacheReserve.typescript.md}
+     */
+    createZoneCacheReserve(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const zoneId = props.zoneId
+            ? props.zoneId
+            : this.resolveZone(`${id}-data-zone`, scope, { name: scope.props.domainName })?.id;
+        const zoneCacheReserve = new zone_cache_reserve_1.ZoneCacheReserve(scope, `${id}`, {
+            ...props,
+            zoneId,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneCacheReserveFriendlyUniqueId`, scope, zoneCacheReserve.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneCacheReserveId`, scope, zoneCacheReserve.id);
+        return zoneCacheReserve;
+    }
+    /**
+     * @summary Method to create a new zone cache variants
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props zone cache variants properties
+     * @see [CDKTF Zone Cache Variants Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zoneCacheVariants.typescript.md}
+     */
+    createZoneCacheVariants(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const zoneId = props.zoneId
+            ? props.zoneId
+            : this.resolveZone(`${id}-data-zone`, scope, { name: scope.props.domainName })?.id;
+        const zoneCacheVariants = new zone_cache_variants_1.ZoneCacheVariants(scope, `${id}`, {
+            ...props,
+            zoneId,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneCacheVariantsFriendlyUniqueId`, scope, zoneCacheVariants.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneCacheVariantsId`, scope, zoneCacheVariants.id);
+        return zoneCacheVariants;
+    }
+    /**
+     * @summary Method to create a new zone dnssec
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props zone dnssec properties
+     * @see [CDKTF Zone DNS Security Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zoneDnssec.typescript.md}
+     */
+    createZoneDnssec(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const zoneId = props.zoneId
+            ? props.zoneId
+            : this.resolveZone(`${id}-data-zone`, scope, { name: scope.props.domainName })?.id;
+        const zoneDnssec = new zone_dnssec_1.ZoneDnssec(scope, `${id}`, {
+            ...props,
+            zoneId,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneDnssecFriendlyUniqueId`, scope, zoneDnssec.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneDnssecId`, scope, zoneDnssec.id);
+        return zoneDnssec;
+    }
+    /**
+     * @summary Method to create a new zone hold
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props zone hold properties
+     * @see [CDKTF Zone Hold Security Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zoneHold.typescript.md}
+     */
+    createZoneHold(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const zoneId = props.zoneId
+            ? props.zoneId
+            : this.resolveZone(`${id}-data-zone`, scope, { name: scope.props.domainName })?.id;
+        const zoneHold = new zone_hold_1.ZoneHold(scope, `${id}`, {
+            ...props,
+            zoneId,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneHoldFriendlyUniqueId`, scope, zoneHold.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneHoldId`, scope, zoneHold.id);
+        return zoneHold;
+    }
+    /**
+     * @summary Method to create a new zone lockdown
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props zone lockdown properties
+     * @see [CDKTF Zone Lockdown Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zoneLockdown.typescript.md}
+     */
+    createZoneLockdown(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const zoneId = props.zoneId
+            ? props.zoneId
+            : this.resolveZone(`${id}-data-zone`, scope, { name: scope.props.domainName })?.id;
+        const zoneLockdown = new zone_lockdown_1.ZoneLockdown(scope, `${id}`, {
+            ...props,
+            zoneId,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneLockdownFriendlyUniqueId`, scope, zoneLockdown.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneLockdownId`, scope, zoneLockdown.id);
+        return zoneLockdown;
+    }
+    /**
+     * @summary Method to create a new zone settings override
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props zone settings override properties
+     * @see [CDKTF Zone Settings Override Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zoneSettingsOverride.typescript.md}
+     */
+    createZoneSettingsOverride(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const zoneId = props.zoneId
+            ? props.zoneId
+            : this.resolveZone(`${id}-data-zone`, scope, { name: scope.props.domainName })?.id;
+        const zoneSettingsOverride = new zone_settings_override_1.ZoneSettingsOverride(scope, `${id}`, {
+            ...props,
+            zoneId,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneSettingsOverrideFriendlyUniqueId`, scope, zoneSettingsOverride.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-zoneSettingsOverrideId`, scope, zoneSettingsOverride.id);
+        return zoneSettingsOverride;
+    }
+}
+exports.CloudflareZoneManager = CloudflareZoneManager;

package/dist/src/lib/cloudflare/services/zone/types.d.ts

@@ -0,0 +1,25 @@
+import { ZoneConfig } from '@cdktf/provider-cloudflare/lib/zone';
+import { ZoneCacheReserveConfig } from '@cdktf/provider-cloudflare/lib/zone-cache-reserve';
+import { ZoneCacheVariantsConfig } from '@cdktf/provider-cloudflare/lib/zone-cache-variants';
+import { ZoneDnssecConfig } from '@cdktf/provider-cloudflare/lib/zone-dnssec';
+import { ZoneHoldConfig } from '@cdktf/provider-cloudflare/lib/zone-hold';
+import { ZoneLockdownConfig } from '@cdktf/provider-cloudflare/lib/zone-lockdown';
+import { ZoneSettingsOverrideConfig } from '@cdktf/provider-cloudflare/lib/zone-settings-override';
+export interface ZoneProps extends ZoneConfig {
+}
+export interface ZoneOptions {
+    id?: string;
+    name?: string;
+}
+export interface ZoneCacheReserveProps extends ZoneCacheReserveConfig {
+}
+export interface ZoneCacheVariantsProps extends ZoneCacheVariantsConfig {
+}
+export interface ZoneDnssecProps extends ZoneDnssecConfig {
+}
+export interface ZoneHoldProps extends ZoneHoldConfig {
+}
+export interface ZoneLockdownProps extends ZoneLockdownConfig {
+}
+export interface ZoneSettingsOverrideProps extends ZoneSettingsOverrideConfig {
+}

package/dist/src/lib/cloudflare/services/zone/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/lib/cloudflare/types/index.d.ts

@@ -0,0 +1,3 @@
+export interface BaseCloudflareProps {
+    accountId: string;
+}

package/dist/src/lib/cloudflare/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/lib/cloudflare/utils/index.d.ts

@@ -0,0 +1,3 @@
+import { TerraformOutput } from 'cdktf';
+import { CommonCloudflareConstruct } from '../common';
+export declare const createCloudflareTfOutput: (id: string, scope: CommonCloudflareConstruct, value?: string, description?: string, sensitive?: boolean, overrideId?: boolean) => TerraformOutput;

package/dist/src/lib/cloudflare/utils/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCloudflareTfOutput = void 0;
+const cdktf_1 = require("cdktf");
+const lodash_1 = __importDefault(require("lodash"));
+const createCloudflareTfOutput = (id, scope, value, description, sensitive, overrideId = true) => {
+    const output = new cdktf_1.TerraformOutput(scope, id, {
+        description,
+        sensitive,
+        value,
+    });
+    if (overrideId) {
+        output.overrideLogicalId(lodash_1.default.camelCase(id));
+    }
+    return output;
+};
+exports.createCloudflareTfOutput = createCloudflareTfOutput;

package/dist/src/lib/index.d.ts

@@ -1,3 +1,4 @@
 export * from './aws';
 export * from './azure';
+export * from './cloudflare';
 export * from './common';

package/dist/src/lib/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./aws"), exports);
 __exportStar(require("./azure"), exports);
+__exportStar(require("./cloudflare"), exports);
 __exportStar(require("./common"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.135.0",
+  "version": "8.137.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -18,6 +18,7 @@
   "keywords": [
     "gradientedge",
     "cdk",
+    "cdktf",
     "awscdk"
   ],
   "license": "MIT",
@@ -46,15 +47,16 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.449.0",
-    "@aws-sdk/credential-providers": "^3.449.0",
-    "@aws-sdk/types": "^3.449.0",
-    "@cdktf/provider-azurerm": "^11.0.4",
+    "@aws-sdk/client-secrets-manager": "^3.454.0",
+    "@aws-sdk/credential-providers": "^3.454.0",
+    "@aws-sdk/types": "^3.451.0",
+    "@cdktf/provider-azurerm": "^11.0.5",
+    "@cdktf/provider-cloudflare": "^10.0.3",
     "@types/lodash": "^4.14.201",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.9.2",
     "@types/uuid": "^9.0.7",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.106.1",
+    "aws-cdk-lib": "^2.110.0",
     "cdktf": "^0.19.1",
     "constructs": "^10.3.0",
     "lodash": "^4.17.21",
@@ -69,15 +71,15 @@
     "@babel/eslint-parser": "^7.23.3",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@types/jest": "^29.5.8",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
-    "aws-cdk": "^2.106.1",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
+    "aws-cdk": "^2.110.0",
     "better-docs": "^2.7.2",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.0",
     "docdash": "^2.0.2",
     "dotenv": "^16.3.1",
-    "eslint": "^8.53.0",
+    "eslint": "^8.54.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-jsdoc": "^46.9.0",
@@ -93,7 +95,7 @@
     "prettier": "^3.1.0",
     "prettier-plugin-organize-imports": "^3.2.4",
     "rimraf": "^5.0.5",
-    "semantic-release": "^22.0.7",
+    "semantic-release": "^22.0.8",
     "taffydb": "^2.7.3",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",

package/src/lib/azure/services/storage/main.ts

@@ -5,7 +5,7 @@ import { StorageAccount } from '@cdktf/provider-azurerm/lib/storage-account'
 import { StorageBlob } from '@cdktf/provider-azurerm/lib/storage-blob'
 import { StorageContainer } from '@cdktf/provider-azurerm/lib/storage-container'
 import { CommonAzureConstruct } from '../../common'
-import { createTfOutput } from '../../utils'
+import { createAzureTfOutput } from '../../utils'
 import { StorageAccountProps, StorageBlobProps, StorageContainerProps } from './types'
 
 /**
@@ -23,7 +23,6 @@ import { StorageAccountProps, StorageBlobProps, StorageContainerProps } from './
  *     this.storageManager.createStorageAccount('MyAccount', this, props)
  *   }
  * }
- * @see [CDKTF S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
  * ```
  */
 export class AzureStorageManager {
@@ -32,6 +31,7 @@ export class AzureStorageManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props storage account properties
+   * @see [CDKTF Storage Account Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/storageAccount.typescript.md}
    */
   public createStorageAccount(id: string, scope: CommonAzureConstruct, props: StorageAccountProps) {
     if (!props) throw `Props undefined for ${id}`
@@ -55,9 +55,9 @@ export class AzureStorageManager {
       },
     })
 
-    createTfOutput(`${id}-storageAccountName`, scope, storageAccount.name)
-    createTfOutput(`${id}-storageAccountFriendlyUniqueId`, scope, storageAccount.friendlyUniqueId)
-    createTfOutput(`${id}-storageAccountId`, scope, storageAccount.id)
+    createAzureTfOutput(`${id}-storageAccountName`, scope, storageAccount.name)
+    createAzureTfOutput(`${id}-storageAccountFriendlyUniqueId`, scope, storageAccount.friendlyUniqueId)
+    createAzureTfOutput(`${id}-storageAccountId`, scope, storageAccount.id)
   }
 
   /**
@@ -65,6 +65,7 @@ export class AzureStorageManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props storage container properties
+   * @see [CDKTF Storage Container Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/storageContainer.typescript.md}
    */
   public createStorageContainer(id: string, scope: CommonAzureConstruct, props: StorageContainerProps) {
     if (!props) throw `Props undefined for ${id}`
@@ -88,9 +89,9 @@ export class AzureStorageManager {
       storageAccountName: storageAccount.name,
     })
 
-    createTfOutput(`${id}-storageContainerName`, scope, storageContainer.name)
-    createTfOutput(`${id}-storageContainerFriendlyUniqueId`, scope, storageContainer.friendlyUniqueId)
-    createTfOutput(`${id}-storageContainerId`, scope, storageContainer.id)
+    createAzureTfOutput(`${id}-storageContainerName`, scope, storageContainer.name)
+    createAzureTfOutput(`${id}-storageContainerFriendlyUniqueId`, scope, storageContainer.friendlyUniqueId)
+    createAzureTfOutput(`${id}-storageContainerId`, scope, storageContainer.id)
   }
 
   /**
@@ -98,6 +99,7 @@ export class AzureStorageManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props storage blob properties
+   * @see [CDKTF Storage Blob Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/storageBlob.typescript.md}
    */
   public createStorageBlob(id: string, scope: CommonAzureConstruct, props: StorageBlobProps) {
     if (!props) throw `Props undefined for ${id}`
@@ -127,8 +129,8 @@ export class AzureStorageManager {
       storageContainerName: storageContainer.name,
     })
 
-    createTfOutput(`${id}-storageBlobName`, scope, storageBlob.name)
-    createTfOutput(`${id}-storageBlobFriendlyUniqueId`, scope, storageBlob.friendlyUniqueId)
-    createTfOutput(`${id}-storageBlobId`, scope, storageBlob.id)
+    createAzureTfOutput(`${id}-storageBlobName`, scope, storageBlob.name)
+    createAzureTfOutput(`${id}-storageBlobFriendlyUniqueId`, scope, storageBlob.friendlyUniqueId)
+    createAzureTfOutput(`${id}-storageBlobId`, scope, storageBlob.id)
   }
 }

package/src/lib/azure/services/storage/types.ts

@@ -1,10 +1,10 @@
 import { StorageAccountConfig } from '@cdktf/provider-azurerm/lib/storage-account'
 import { StorageBlobConfig } from '@cdktf/provider-azurerm/lib/storage-blob'
 import { StorageContainerConfig } from '@cdktf/provider-azurerm/lib/storage-container'
-import { BaseConfigProps } from '../../types'
+import { BaseAzureConfigProps } from '../../types'
 
 export interface StorageAccountProps extends StorageAccountConfig {}
 
-export interface StorageContainerProps extends BaseConfigProps, StorageContainerConfig {}
+export interface StorageContainerProps extends BaseAzureConfigProps, StorageContainerConfig {}
 
-export interface StorageBlobProps extends BaseConfigProps, StorageBlobConfig {}
+export interface StorageBlobProps extends BaseAzureConfigProps, StorageBlobConfig {}

package/src/lib/azure/types/index.ts

@@ -1,3 +1,3 @@
-export interface BaseConfigProps {
+export interface BaseAzureConfigProps {
   resourceGroupName: string
 }

package/src/lib/azure/utils/index.ts

@@ -2,7 +2,7 @@ import { TerraformOutput } from 'cdktf'
 import _ from 'lodash'
 import { CommonAzureConstruct } from '../common'
 
-export const createTfOutput = (
+export const createAzureTfOutput = (
   id: string,
   scope: CommonAzureConstruct,
   value?: string,

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

@@ -0,0 +1,57 @@
+import { CloudflareProvider } from '@cdktf/provider-cloudflare/lib/provider'
+import { TerraformStack } from 'cdktf'
+import { Construct } from 'constructs'
+import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
+import { CloudflareZoneManager } from '../services'
+import { CommonCloudflareStackProps } from './types'
+
+export class CommonCloudflareConstruct extends TerraformStack {
+  declare props: CommonCloudflareStackProps
+  id: string
+  fullyQualifiedDomainName: string
+  zoneManager: CloudflareZoneManager
+
+  constructor(scope: Construct, id: string, props: CommonCloudflareStackProps) {
+    super(scope, id)
+    this.props = props
+    this.id = id
+
+    this.zoneManager = new CloudflareZoneManager()
+
+    this.determineFullyQualifiedDomain()
+    new CloudflareProvider(this, `${this.id}-provider`, this.props)
+  }
+
+  /**
+   * @summary Determine the fully qualified domain name based on domainName & subDomain
+   */
+  protected determineFullyQualifiedDomain(): void {
+    this.fullyQualifiedDomainName = this.props.subDomain
+      ? `${this.props.subDomain}.${this.props.domainName}`
+      : this.props.domainName
+  }
+
+  /**
+   * @summary Utility method to determine if the initialisation is in development (dev) stage
+   * This is determined by the stage property injected via cdk context
+   */
+  public isDevelopmentStage = () => isDevStage(this.props.stage)
+
+  /**
+   * @summary Utility method to determine if the initialisation is in test (tst) stage
+   * This is determined by the stage property injected via cdk context
+   */
+  public isTestStage = () => isTestStage(this.props.stage)
+
+  /**
+   * @summary Utility method to determine if the initialisation is in uat (uat) stage
+   * This is determined by the stage property injected via cdk context
+   */
+  public isUatStage = () => isUatStage(this.props.stage)
+
+  /**
+   * @summary Utility method to determine if the initialisation is in production (prd) stage
+   * This is determined by the stage property injected via cdk context
+   */
+  public isProductionStage = () => isPrdStage(this.props.stage)
+}

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

@@ -0,0 +1,3 @@
+export * from './construct'
+export * from './stack'
+export * from './types'

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

@@ -0,0 +1,143 @@
+import fs from 'fs'
+import { CommonCloudflareConstruct } from './construct'
+import { CommonCloudflareStackProps } from './types'
+
+import appRoot from 'app-root-path'
+import { TerraformStack } from 'cdktf'
+import { Construct } from 'constructs'
+import _ from 'lodash'
+import { isDevStage } from '../../common'
+
+/**
+ * @classdesc Common stack to use as a base for all higher level constructs.
+ * @example
+ * import { CommonCloudflareStack } from '@gradientedge/cdk-utils'
+ *
+ * class CustomStack extends CommonCloudflareStack {
+ *   constructor(parent: App, name: string, props: StackProps) {
+ *     super(parent, name, props)
+ *     // provision resources
+ *   }
+ * }
+ */
+export class CommonCloudflareStack extends TerraformStack {
+  construct: CommonCloudflareConstruct
+  props: CommonCloudflareStackProps
+
+  constructor(parent: Construct, name: string, props: CommonCloudflareStackProps) {
+    super(parent, name)
+
+    /* determine extra cdk contexts */
+    this.determineExtraContexts()
+
+    /* determine extra cdk stage contexts */
+    this.determineStageContexts()
+
+    this.props = this.determineConstructProps(props)
+
+    /* initialise the construct */
+    this.construct = new CommonCloudflareConstruct(this, 'cdk-utils', this.props)
+  }
+
+  /**
+   * @summary Method to determine the core CDK construct properties injected via context cdktf.json
+   * @param props The stack properties
+   * @returns The stack properties
+   */
+  protected determineConstructProps(props: CommonCloudflareStackProps) {
+    return {
+      accountId: this.node.tryGetContext('accountId'),
+      domainName: this.node.tryGetContext('domainName'),
+      extraContexts: this.node.tryGetContext('extraContexts'),
+      features: this.node.tryGetContext('features'),
+      name: this.node.tryGetContext('resourceGroupName'),
+      skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
+      stage: this.node.tryGetContext('stage'),
+      subDomain: this.node.tryGetContext('subDomain'),
+    }
+  }
+
+  /**
+   * @summary Method to determine extra cdk contexts apart from the main cdktf.json
+   * - Sets the properties from the extra contexts into cdk node context
+   * - Primary use is to have layered config in separate files to enable easier maintenance and readability
+   */
+  protected determineExtraContexts() {
+    const extraContexts = this.node.tryGetContext('extraContexts')
+    const debug = this.node.tryGetContext('debug')
+
+    if (!extraContexts) {
+      if (debug) console.debug(`No additional contexts provided. Using default context properties from cdktf.json`)
+      return
+    }
+
+    _.forEach(extraContexts, (context: string) => {
+      const extraContextPath = `${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}`
+
+      /* read the extra properties */
+      const extraContextPropsBuffer = fs.readFileSync(extraContextPath)
+      if (debug) console.debug(`Adding additional contexts provided in ${extraContextPath}`)
+
+      /* parse as JSON properties */
+      const extraContextProps = JSON.parse(extraContextPropsBuffer.toString('utf-8'))
+
+      /* set each of the property into the cdk node context */
+      _.keys(extraContextProps).forEach((propKey: any) => {
+        this.node.setContext(propKey, extraContextProps[propKey])
+      })
+    })
+  }
+
+  /**
+   * @summary Method to determine extra cdk stage contexts apart from the main cdktf.json
+   * - Sets the properties from the extra stage contexts into cdk node context
+   * - Primary use is to have layered config for each environment which is injected into the context
+   */
+  protected determineStageContexts() {
+    const stage = this.node.tryGetContext('stage')
+    const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv'
+    const stageContextFilePath = `${appRoot.path}/${stageContextPath}/${stage}.json`
+    const debug = this.node.tryGetContext('debug')
+
+    if (isDevStage(stage)) {
+      if (debug) console.debug(`Development stage. Using default stage context properties`)
+    }
+
+    /* alert default context usage when extra stage config is missing */
+    if (!fs.existsSync(stageContextFilePath)) {
+      if (debug) console.debug(`Stage specific context properties unavailable in path:${stageContextFilePath}`)
+      if (debug) console.debug(`Using default stage context properties for ${stage} stage`)
+      return
+    }
+
+    /* read the extra properties */
+    const stageContextPropsBuffer = fs.readFileSync(stageContextFilePath)
+    if (debug) console.debug(`Adding additional stage contexts provided in ${stageContextFilePath}`)
+
+    /* parse as JSON properties */
+    const stageContextProps = JSON.parse(stageContextPropsBuffer.toString('utf-8'))
+
+    /* set each of the property into the cdk node context */
+    _.keys(stageContextProps).forEach((propKey: any) => {
+      /* handle object, array properties */
+      if (typeof stageContextProps[propKey] === 'object' && !Array.isArray(stageContextProps[propKey])) {
+        this.node.setContext(propKey, _.merge(this.node.tryGetContext(propKey), stageContextProps[propKey]))
+      } else {
+        /* handle all other primitive properties */
+        this.node.setContext(propKey, stageContextProps[propKey])
+      }
+    })
+  }
+
+  /**
+   * @summary Determine the fully qualified domain name based on domainName & subDomain
+   */
+  protected fullyQualifiedDomain() {
+    const domainName = this.node.tryGetContext('domainName')
+    const subDomain = this.node.tryGetContext('subDomain')
+    return subDomain ? `${subDomain}.${domainName}` : domainName
+  }
+}

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

@@ -0,0 +1,8 @@
+import { CloudflareProviderConfig } from '@cdktf/provider-cloudflare/lib/provider'
+import { BaseProps } from '../../common'
+
+/**
+ */
+export interface CommonCloudflareStackProps extends BaseProps, CloudflareProviderConfig {
+  accountId: string
+}

package/src/lib/cloudflare/index.ts

@@ -0,0 +1,4 @@
+export * from './common'
+export * from './services'
+export * from './types'
+export * from './utils'