@gradientedge/cdk-utils 8.121.0 → 8.122.0

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

@@ -0,0 +1,43 @@
+import { CommonAzureConstruct } from '../../common';
+import { StorageAccountProps, StorageBlobProps, StorageContainerProps } from './types';
+/**
+ * @classdesc Provides operations on Azure Storage
+ * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
+ * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
+ * @example
+ * ```
+ * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     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 declare class AzureStorageManager {
+    /**
+     * @summary Method to create a new storage account
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props storage account properties
+     */
+    createStorageAccount(id: string, scope: CommonAzureConstruct, props: StorageAccountProps): void;
+    /**
+     * @summary Method to create a new storage container
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props storage container properties
+     */
+    createStorageContainer(id: string, scope: CommonAzureConstruct, props: StorageContainerProps): void;
+    /**
+     * @summary Method to create a new storage blob
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props storage blob properties
+     */
+    createStorageBlob(id: string, scope: CommonAzureConstruct, props: StorageBlobProps): void;
+}

package/dist/src/lib/azure/services/storage/main.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AzureStorageManager = void 0;
+const data_azurerm_resource_group_1 = require("@cdktf/provider-azurerm/lib/data-azurerm-resource-group");
+const data_azurerm_storage_account_1 = require("@cdktf/provider-azurerm/lib/data-azurerm-storage-account");
+const data_azurerm_storage_container_1 = require("@cdktf/provider-azurerm/lib/data-azurerm-storage-container");
+const storage_account_1 = require("@cdktf/provider-azurerm/lib/storage-account");
+const storage_blob_1 = require("@cdktf/provider-azurerm/lib/storage-blob");
+const storage_container_1 = require("@cdktf/provider-azurerm/lib/storage-container");
+const utils_1 = require("../../utils");
+/**
+ * @classdesc Provides operations on Azure Storage
+ * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
+ * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
+ * @example
+ * ```
+ * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     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}
+ * ```
+ */
+class AzureStorageManager {
+    /**
+     * @summary Method to create a new storage account
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props storage account properties
+     */
+    createStorageAccount(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-sc-rg`, {
+            name: scope.props.resourceGroupName
+                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
+                : `${props.resourceGroupName}-${scope.props.stage}`,
+        });
+        if (!resourceGroup)
+            throw `Resource group undefined for ${id}`;
+        const storageAccount = new storage_account_1.StorageAccount(scope, `${id}-sa`, {
+            ...props,
+            accountTier: props.accountTier ?? 'Standard',
+            location: props.location ?? resourceGroup.location,
+            name: `${props.name}-${scope.props.stage}`,
+            resourceGroupName: resourceGroup.name,
+            tags: props.tags ?? {
+                environment: scope.props.stage,
+            },
+        });
+        (0, utils_1.createTfOutput)(`${id}-storageAccountName`, scope, storageAccount.name);
+        (0, utils_1.createTfOutput)(`${id}-storageAccountFriendlyUniqueId`, scope, storageAccount.friendlyUniqueId);
+        (0, utils_1.createTfOutput)(`${id}-storageAccountId`, scope, storageAccount.id);
+    }
+    /**
+     * @summary Method to create a new storage container
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props storage container properties
+     */
+    createStorageContainer(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-sc-rg`, {
+            name: scope.props.resourceGroupName
+                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
+                : `${props.resourceGroupName}-${scope.props.stage}`,
+        });
+        if (!resourceGroup)
+            throw `Resource group undefined for ${id}`;
+        const storageAccount = new data_azurerm_storage_account_1.DataAzurermStorageAccount(scope, `${id}-sa`, {
+            name: `${props.storageAccountName}-${scope.props.stage}`,
+            resourceGroupName: resourceGroup.name,
+        });
+        const storageContainer = new storage_container_1.StorageContainer(scope, `${id}-sc`, {
+            ...props,
+            name: `${props.name}-${scope.props.stage}`,
+            storageAccountName: storageAccount.name,
+        });
+        (0, utils_1.createTfOutput)(`${id}-storageContainerName`, scope, storageContainer.name);
+        (0, utils_1.createTfOutput)(`${id}-storageContainerFriendlyUniqueId`, scope, storageContainer.friendlyUniqueId);
+        (0, utils_1.createTfOutput)(`${id}-storageContainerId`, scope, storageContainer.id);
+    }
+    /**
+     * @summary Method to create a new storage blob
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props storage blob properties
+     */
+    createStorageBlob(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-sb-rg`, {
+            name: scope.props.resourceGroupName
+                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
+                : `${props.resourceGroupName}-${scope.props.stage}`,
+        });
+        if (!resourceGroup)
+            throw `Resource group undefined for ${id}`;
+        const storageAccount = new data_azurerm_storage_account_1.DataAzurermStorageAccount(scope, `${id}-sa`, {
+            name: `${props.storageAccountName}-${scope.props.stage}`,
+            resourceGroupName: resourceGroup.name,
+        });
+        const storageContainer = new data_azurerm_storage_container_1.DataAzurermStorageContainer(scope, `${id}-sc`, {
+            name: `${props.storageContainerName}-${scope.props.stage}`,
+            storageAccountName: storageAccount.name,
+        });
+        const storageBlob = new storage_blob_1.StorageBlob(scope, `${id}-sb`, {
+            ...props,
+            name: `${props.name}-${scope.props.stage}`,
+            storageAccountName: storageAccount.name,
+            storageContainerName: storageContainer.name,
+        });
+        (0, utils_1.createTfOutput)(`${id}-storageBlobName`, scope, storageBlob.name);
+        (0, utils_1.createTfOutput)(`${id}-storageBlobFriendlyUniqueId`, scope, storageBlob.friendlyUniqueId);
+        (0, utils_1.createTfOutput)(`${id}-storageBlobId`, scope, storageBlob.id);
+    }
+}
+exports.AzureStorageManager = AzureStorageManager;

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

@@ -0,0 +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';
+export interface StorageAccountProps extends StorageAccountConfig {
+}
+export interface StorageContainerProps extends BaseConfigProps, StorageContainerConfig {
+}
+export interface StorageBlobProps extends BaseConfigProps, StorageBlobConfig {
+}

package/dist/src/lib/azure/services/storage/types.js

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

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

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

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

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

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

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

package/dist/src/lib/azure/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.createTfOutput = void 0;
+const cdktf_1 = require("cdktf");
+const lodash_1 = __importDefault(require("lodash"));
+const createTfOutput = (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.createTfOutput = createTfOutput;

package/dist/src/lib/common/construct.d.ts

@@ -0,0 +1,29 @@
+import { Construct } from 'constructs';
+import { BaseProps } from './types';
+export declare abstract class BaseConstruct extends Construct {
+    props: BaseProps;
+    /**
+     * @summary Determine the fully qualified domain name based on domainName & subDomain
+     */
+    abstract determineFullyQualifiedDomain(): void;
+    /**
+     * @summary Utility method to determine if the initialisation is in development (dev) stage
+     * This is determined by the stage property injected via cdk context
+     */
+    abstract isDevelopmentStage(): void;
+    /**
+     * @summary Utility method to determine if the initialisation is in test (tst) stage
+     * This is determined by the stage property injected via cdk context
+     */
+    abstract isTestStage(): void;
+    /**
+     * @summary Utility method to determine if the initialisation is in uat (uat) stage
+     * This is determined by the stage property injected via cdk context
+     */
+    abstract isUatStage(): void;
+    /**
+     * @summary Utility method to determine if the initialisation is in production (prd) stage
+     * This is determined by the stage property injected via cdk context
+     */
+    abstract isProductionStage(): void;
+}

package/dist/src/lib/common/construct.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseConstruct = void 0;
+const constructs_1 = require("constructs");
+class BaseConstruct extends constructs_1.Construct {
+    props;
+}
+exports.BaseConstruct = BaseConstruct;

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

@@ -0,0 +1,5 @@
+export * from './construct';
+export * from './stack';
+export * from './types';
+export * from './utils';
+export declare const applyMixins: (derivedCtor: any, constructors: any[]) => void;

package/dist/src/lib/common/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyMixins = void 0;
+__exportStar(require("./construct"), exports);
+__exportStar(require("./stack"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
+const applyMixins = (derivedCtor, constructors) => {
+    constructors.forEach(baseCtor => {
+        Object.getOwnPropertyNames(baseCtor.prototype).forEach(name => {
+            Object.defineProperty(derivedCtor.prototype, name, Object.getOwnPropertyDescriptor(baseCtor.prototype, name) || Object.create(null));
+        });
+    });
+};
+exports.applyMixins = applyMixins;

package/dist/src/lib/common/stack.d.ts

@@ -0,0 +1,21 @@
+import { Construct } from 'constructs';
+import { BaseProps } from './types';
+export declare abstract class BaseStack extends Construct {
+    props: BaseProps;
+    /**
+     * @summary Method to determine the core CDK construct properties injected via context cdktf.json
+     */
+    protected abstract determineConstructProps(props: BaseProps): void;
+    /**
+     * @summary Method to determine extra cdk contexts apart from the main cdktf.json
+     */
+    abstract determineExtraContexts(): void;
+    /**
+     * @summary Method to determine extra cdk stage contexts apart from the main cdktf.json
+     */
+    abstract determineStageContexts(): void;
+    /**
+     * @summary Determine the fully qualified domain name based on domainName & subDomain
+     */
+    abstract fullyQualifiedDomain(): void;
+}

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseStack = void 0;
+const constructs_1 = require("constructs");
+class BaseStack extends constructs_1.Construct {
+    props;
+}
+exports.BaseStack = BaseStack;

package/dist/src/lib/common/types.d.ts

@@ -0,0 +1,9 @@
+export interface BaseProps {
+    domainName: string;
+    extraContexts?: string[];
+    name: string;
+    skipStageForARecords: boolean;
+    stage: string;
+    stageContextPath?: string;
+    subDomain?: string;
+}

package/dist/src/lib/common/types.js

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

package/dist/src/lib/common/utils.d.ts

@@ -0,0 +1,26 @@
+/**
+ */
+export declare enum LogLevel {
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARNING = "WARNING",
+    TRACE = "TRACE",
+    ERROR = "ERROR",
+    CRITICAL = "CRITICAL"
+}
+/**
+ * @param stage
+ */
+export declare const isDevStage: (stage: string) => boolean;
+/**
+ * @param stage
+ */
+export declare const isTestStage: (stage: string) => boolean;
+/**
+ * @param stage
+ */
+export declare const isUatStage: (stage: string) => boolean;
+/**
+ * @param stage
+ */
+export declare const isPrdStage: (stage: string) => boolean;

package/dist/src/lib/common/utils.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPrdStage = exports.isUatStage = exports.isTestStage = exports.isDevStage = exports.LogLevel = void 0;
+/**
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["DEBUG"] = "DEBUG";
+    LogLevel["INFO"] = "INFO";
+    LogLevel["WARNING"] = "WARNING";
+    LogLevel["TRACE"] = "TRACE";
+    LogLevel["ERROR"] = "ERROR";
+    LogLevel["CRITICAL"] = "CRITICAL";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+/**
+ * @param stage
+ */
+const isDevStage = (stage) => stage === 'dev';
+exports.isDevStage = isDevStage;
+/**
+ * @param stage
+ */
+const isTestStage = (stage) => stage === 'tst';
+exports.isTestStage = isTestStage;
+/**
+ * @param stage
+ */
+const isUatStage = (stage) => stage === 'uat';
+exports.isUatStage = isUatStage;
+/**
+ * @param stage
+ */
+const isPrdStage = (stage) => stage === 'prd';
+exports.isPrdStage = isPrdStage;

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

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

package/dist/src/lib/index.js

@@ -15,3 +15,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("./common"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.121.0",
+  "version": "8.122.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -49,11 +49,13 @@
     "@aws-sdk/client-secrets-manager": "^3.405.0",
     "@aws-sdk/credential-providers": "^3.405.0",
     "@aws-sdk/types": "^3.398.0",
+    "@cdktf/provider-azurerm": "^10.0.1",
     "@types/lodash": "^4.14.197",
     "@types/node": "^20.5.9",
     "@types/uuid": "^9.0.3",
     "app-root-path": "^3.1.0",
     "aws-cdk-lib": "^2.94.0",
+    "cdktf": "^0.18.0",
     "constructs": "^10.2.70",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",

package/setup.js

@@ -0,0 +1,2 @@
+const cdktf = require('cdktf')
+cdktf.Testing.setupJest()

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

@@ -1,5 +1,6 @@
 import { CfnOutput } from 'aws-cdk-lib'
 import { Construct } from 'constructs'
+import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
 import {
   AcmManager,
   ApiManager,
@@ -31,7 +32,7 @@ import {
   VpcManager,
   WafManager,
 } from '../services'
-import { createCfnOutput, isDevStage, isPrdStage, isTestStage, isUatStage } from '../utils'
+import { createCfnOutput } from '../utils'
 import { CommonStackProps } from './types'
 
 /**
@@ -161,15 +162,3 @@ export class CommonConstruct extends Construct {
    */
   public isProductionStage = () => isPrdStage(this.props.stage)
 }
-
-export const applyMixins = (derivedCtor: any, constructors: any[]) => {
-  constructors.forEach(baseCtor => {
-    Object.getOwnPropertyNames(baseCtor.prototype).forEach(name => {
-      Object.defineProperty(
-        derivedCtor.prototype,
-        name,
-        Object.getOwnPropertyDescriptor(baseCtor.prototype, name) || Object.create(null)
-      )
-    })
-  })
-}

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

@@ -1,11 +1,11 @@
 import { App, Stack, StackProps } from 'aws-cdk-lib'
 import { Runtime } from 'aws-cdk-lib/aws-lambda'
 import fs from 'fs'
-import { isDevStage } from '../utils'
 import { CommonConstruct } from './construct'
 import { CommonStackProps } from './types'
 
 import appRoot from 'app-root-path'
+import { isDevStage } from '../../common'
 
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.

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

@@ -1,18 +1,12 @@
 import { StackProps } from 'aws-cdk-lib'
 import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda'
 import { RetentionDays } from 'aws-cdk-lib/aws-logs'
+import { BaseProps } from '../../common'
 
 /**
  */
-export interface CommonStackProps extends StackProps {
-  name: string
+export interface CommonStackProps extends BaseProps, StackProps {
   region: string
-  stage: string
-  domainName: string
-  subDomain?: string
-  extraContexts?: string[]
-  stageContextPath?: string
-  skipStageForARecords: boolean
   logRetention?: RetentionDays
   defaultReservedLambdaConcurrentExecutions?: number
   defaultTracing?: Tracing

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

@@ -1 +1,6 @@
-export * from './aws'
+/**
+ */
+export interface TagProps {
+  key: string
+  value: string
+}

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

@@ -1,43 +1,55 @@
-export * from './aws'
+import { fromEnv, fromIni } from '@aws-sdk/credential-providers'
+import { AwsCredentialIdentityProvider } from '@aws-sdk/types'
+import { CfnOutput } from 'aws-cdk-lib'
+import _ from 'lodash'
+import { CommonConstruct } from '../common'
 
 /**
+ * @summary Helper method to add CloudFormation outputs from the construct
+ * @param id scoped id of the resource
+ * @param scope scope in which this resource is defined
+ * @param value the value of the exported output
+ * @param description optional description for the output
+ * @param overrideId Flag which indicates whether to override the default logical id of the output
+ * @returns The CloudFormation output
  */
-const defaultResponseObject = {
-  body: '',
-  headers: {
-    'Access-Control-Allow-Origin': '*',
-  },
-  isBase64Encoded: false,
-  statusCode: 200,
+export function createCfnOutput(
+  id: string,
+  scope: CommonConstruct,
+  value?: string,
+  description?: string,
+  overrideId = true
+): CfnOutput {
+  const camelName = _.camelCase(id)
+  const output = new CfnOutput(scope, id, {
+    description,
+    exportName: `${scope.props.stackName}-${camelName}`,
+    value: value ?? '',
+  })
+  if (overrideId) {
+    output.overrideLogicalId(camelName)
+  }
+  return output
 }
 
 /**
+ *
  */
-export enum LogLevel {
-  DEBUG = 'DEBUG',
-  INFO = 'INFO',
-  WARNING = 'WARNING',
-  TRACE = 'TRACE',
-  ERROR = 'ERROR',
-  CRITICAL = 'CRITICAL',
+export function determineCredentials(): AwsCredentialIdentityProvider {
+  if (process.env.AWS_PROFILE) return fromIni()
+  return fromEnv()
 }
 
 /**
- * @param stage
- */
-export const isDevStage = (stage: string) => stage === 'dev'
-/**
- * @param stage
- */
-export const isTestStage = (stage: string) => stage === 'tst'
-/**
- * @param stage
- */
-export const isUatStage = (stage: string) => stage === 'uat'
-/**
- * @param stage
  */
-export const isPrdStage = (stage: string) => stage === 'prd'
+const defaultResponseObject = {
+  body: '',
+  headers: {
+    'Access-Control-Allow-Origin': '*',
+  },
+  isBase64Encoded: false,
+  statusCode: 200,
+}
 
 /**
  * @param error

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

@@ -0,0 +1,57 @@
+import { AzurermProvider } from '@cdktf/provider-azurerm/lib/provider'
+import { TerraformStack } from 'cdktf'
+import { Construct } from 'constructs'
+import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
+import { AzureStorageManager } from '../services'
+import { CommonAzureStackProps } from './types'
+
+export class CommonAzureConstruct extends TerraformStack {
+  declare props: CommonAzureStackProps
+  id: string
+  fullyQualifiedDomainName: string
+  storageManager: AzureStorageManager
+
+  constructor(scope: Construct, id: string, props: CommonAzureStackProps) {
+    super(scope, id)
+    this.props = props
+    this.id = id
+
+    this.storageManager = new AzureStorageManager()
+
+    this.determineFullyQualifiedDomain()
+    new AzurermProvider(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)
+}