@gradientedge/cdk-utils-azure 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Gradient Edge, https://github.com/gradientedge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/src/common/constants.d.ts

@@ -0,0 +1,83 @@
+export declare enum AzureRemoteBackend {
+    azurerm = "azurerm",
+    pulumi = "pulumi",
+    local = "local"
+}
+/**
+ * List of Azure resources that excludes tags
+ */
+export declare const RESOURCES_TO_EXCLUDE_TAGS: Set<string>;
+/**
+ * @see https://learn.microsoft.com/en-us/azure/reliability/regions-list?tabs=all
+ */
+export declare const AzureLocation: {
+    readonly BrazilSouth: "brazilsouth";
+    readonly BrazilSoutheast: "brazilsoutheast";
+    readonly CanadaCentral: "canadacentral";
+    readonly CanadaEast: "canadaeast";
+    readonly CentralUS: "centralus";
+    readonly EastUS: "eastus";
+    readonly EastUS2: "eastus2";
+    readonly MexicoCentral: "mexicocentral";
+    readonly NorthCentralUS: "northcentralus";
+    readonly SouthCentralUS: "southcentralus";
+    readonly USGovArizona: "usgovarizona";
+    readonly USGovTexas: "usgovtexas";
+    readonly USGovVirginia: "usgovvirginia";
+    readonly WestCentralUS: "westcentralus";
+    readonly WestUS: "westus";
+    readonly WestUS2: "westus2";
+    readonly WestUS3: "westus3";
+    readonly AustriaCentral: "austriacentral";
+    readonly BelgiumCentral: "belgiumcentral";
+    readonly DenmarkEast: "denmarkeast";
+    readonly FinlandCentral: "finlandcentral";
+    readonly FranceCentral: "francecentral";
+    readonly FranceSouth: "francesouth";
+    readonly GermanyNorth: "germanynorth";
+    readonly GermanyWestCentral: "germanywestcentral";
+    readonly GreeceHydra: "greecehydra";
+    readonly ItalyNorth: "italynorth";
+    readonly NorthEurope: "northeurope";
+    readonly NorwayEast: "norwayeast";
+    readonly NorwayWest: "norwaywest";
+    readonly PolandCentral: "polandcentral";
+    readonly SpainCentral: "spaincentral";
+    readonly SwedenCentral: "swedencentral";
+    readonly SwedenSouth: "swedensouth";
+    readonly SwitzerlandNorth: "switzerlandnorth";
+    readonly SwitzerlandWest: "switzerlandwest";
+    readonly UKSouth: "uksouth";
+    readonly UKWest: "ukwest";
+    readonly WestEurope: "westeurope";
+    readonly IsraelCentral: "israelcentral";
+    readonly QatarCentral: "qatarcentral";
+    readonly SouthAfricaNorth: "southafricanorth";
+    readonly SouthAfricaWest: "southafricawest";
+    readonly UAECentral: "uaecentral";
+    readonly UAENorth: "uaenorth";
+    readonly AustraliaCentral: "australiacentral";
+    readonly AustraliaCentral2: "australiacentral2";
+    readonly AustraliaEast: "australiaeast";
+    readonly AustraliaSoutheast: "australiasoutheast";
+    readonly CentralIndia: "centralindia";
+    readonly ChinaEast: "chinaeast";
+    readonly ChinaEast2: "chinaeast2";
+    readonly ChinaNorth: "chinanorth";
+    readonly ChinaNorth2: "chinanorth2";
+    readonly ChinaNorth3: "chinanorth3";
+    readonly EastAsia: "eastasia";
+    readonly JapanEast: "japaneast";
+    readonly JapanWest: "japanwest";
+    readonly KoreaCentral: "koreacentral";
+    readonly KoreaSouth: "koreasouth";
+    readonly MalaysiaSouth: "malaysiasouth";
+    readonly MalaysiaWest: "malaysiawest";
+    readonly NewZealandNorth: "newzealandnorth";
+    readonly SoutheastAsia: "southeastasia";
+    readonly SouthIndia: "southindia";
+    readonly TaiwanNorth: "taiwannorth";
+    readonly TaiwanNorthwest: "taiwannorthwest";
+    readonly WestIndia: "westindia";
+};
+export type AzureLocation = (typeof AzureLocation)[keyof typeof AzureLocation];

package/dist/src/common/constants.js

@@ -0,0 +1,87 @@
+export var AzureRemoteBackend;
+(function (AzureRemoteBackend) {
+    AzureRemoteBackend["azurerm"] = "azurerm";
+    AzureRemoteBackend["pulumi"] = "pulumi";
+    AzureRemoteBackend["local"] = "local";
+})(AzureRemoteBackend || (AzureRemoteBackend = {}));
+/**
+ * List of Azure resources that excludes tags
+ */
+export const RESOURCES_TO_EXCLUDE_TAGS = new Set(['ApiManagementNamedValue', 'Application', 'ServicePrincipal']);
+/**
+ * @see https://learn.microsoft.com/en-us/azure/reliability/regions-list?tabs=all
+ */
+export const AzureLocation = {
+    // Americas
+    BrazilSouth: 'brazilsouth',
+    BrazilSoutheast: 'brazilsoutheast',
+    CanadaCentral: 'canadacentral',
+    CanadaEast: 'canadaeast',
+    CentralUS: 'centralus',
+    EastUS: 'eastus',
+    EastUS2: 'eastus2',
+    MexicoCentral: 'mexicocentral',
+    NorthCentralUS: 'northcentralus',
+    SouthCentralUS: 'southcentralus',
+    USGovArizona: 'usgovarizona',
+    USGovTexas: 'usgovtexas',
+    USGovVirginia: 'usgovvirginia',
+    WestCentralUS: 'westcentralus',
+    WestUS: 'westus',
+    WestUS2: 'westus2',
+    WestUS3: 'westus3',
+    // Europe
+    AustriaCentral: 'austriacentral',
+    BelgiumCentral: 'belgiumcentral',
+    DenmarkEast: 'denmarkeast',
+    FinlandCentral: 'finlandcentral',
+    FranceCentral: 'francecentral',
+    FranceSouth: 'francesouth',
+    GermanyNorth: 'germanynorth',
+    GermanyWestCentral: 'germanywestcentral',
+    GreeceHydra: 'greecehydra',
+    ItalyNorth: 'italynorth',
+    NorthEurope: 'northeurope',
+    NorwayEast: 'norwayeast',
+    NorwayWest: 'norwaywest',
+    PolandCentral: 'polandcentral',
+    SpainCentral: 'spaincentral',
+    SwedenCentral: 'swedencentral',
+    SwedenSouth: 'swedensouth',
+    SwitzerlandNorth: 'switzerlandnorth',
+    SwitzerlandWest: 'switzerlandwest',
+    UKSouth: 'uksouth',
+    UKWest: 'ukwest',
+    WestEurope: 'westeurope',
+    // Middle East & Africa
+    IsraelCentral: 'israelcentral',
+    QatarCentral: 'qatarcentral',
+    SouthAfricaNorth: 'southafricanorth',
+    SouthAfricaWest: 'southafricawest',
+    UAECentral: 'uaecentral',
+    UAENorth: 'uaenorth',
+    // Asia Pacific
+    AustraliaCentral: 'australiacentral',
+    AustraliaCentral2: 'australiacentral2',
+    AustraliaEast: 'australiaeast',
+    AustraliaSoutheast: 'australiasoutheast',
+    CentralIndia: 'centralindia',
+    ChinaEast: 'chinaeast',
+    ChinaEast2: 'chinaeast2',
+    ChinaNorth: 'chinanorth',
+    ChinaNorth2: 'chinanorth2',
+    ChinaNorth3: 'chinanorth3',
+    EastAsia: 'eastasia',
+    JapanEast: 'japaneast',
+    JapanWest: 'japanwest',
+    KoreaCentral: 'koreacentral',
+    KoreaSouth: 'koreasouth',
+    MalaysiaSouth: 'malaysiasouth',
+    MalaysiaWest: 'malaysiawest',
+    NewZealandNorth: 'newzealandnorth',
+    SoutheastAsia: 'southeastasia',
+    SouthIndia: 'southindia',
+    TaiwanNorth: 'taiwannorth',
+    TaiwanNorthwest: 'taiwannorthwest',
+    WestIndia: 'westindia',
+};

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

@@ -0,0 +1,80 @@
+import { GetWorkspaceResult, Workspace } from '@pulumi/azure-native/operationalinsights/index.js';
+import { ResourceGroup } from '@pulumi/azure-native/resources/index.js';
+import * as pulumi from '@pulumi/pulumi';
+import { ComponentResource, ComponentResourceOptions, Output } from '@pulumi/pulumi';
+import { AzureAuthorisationManager } from '../services/authorisation/main.js';
+import { AzureApiManagementManager, AzureAppConfigurationManager, AzureApplicationInsightsManager, AzureAppServiceManager, AzureCosmosDbManager, AzureDnsManager, AzureEventgridManager, AzureFunctionManager, AzureKeyVaultManager, AzureMonitorManager, AzureOperationalInsightsManager, AzurePortalManager, AzureRedisManager, AzureResourceGroupManager, AzureSecurityCentermanager, AzureServiceBusManager, AzureStorageManager } from '../services/index.js';
+import { AzureResourceNameFormatter } from './resource-name-formatter.js';
+import { CommonAzureStackProps } from './types.js';
+/**
+ * @classdesc Common Azure construct to use as a base for all higher level constructs using Pulumi
+ * - Provides manager instances for all Azure services
+ * - Handles resource naming conventions
+ * - Manages common properties and utilities
+ * @example
+ * ```typescript
+ * import { CommonAzureConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(name: string, props: CommonAzureStackProps) {
+ *     super(name, props)
+ *     // provision resources using this.resourceGroupManager, etc.
+ *   }
+ * }
+ * ```
+ */
+export declare class CommonAzureConstruct extends ComponentResource {
+    props: CommonAzureStackProps;
+    options?: ComponentResourceOptions;
+    id: string;
+    resourceGroup: ResourceGroup;
+    fullyQualifiedDomainName: string;
+    authorisationManager: AzureAuthorisationManager;
+    apiManagementManager: AzureApiManagementManager;
+    appConfigurationManager: AzureAppConfigurationManager;
+    appServiceManager: AzureAppServiceManager;
+    applicationInsightsManager: AzureApplicationInsightsManager;
+    cosmosDbManager: AzureCosmosDbManager;
+    dnsManager: AzureDnsManager;
+    eventgridManager: AzureEventgridManager;
+    functionManager: AzureFunctionManager;
+    keyVaultManager: AzureKeyVaultManager;
+    operationalInsightsManager: AzureOperationalInsightsManager;
+    portalManager: AzurePortalManager;
+    monitorManager: AzureMonitorManager;
+    redisManager: AzureRedisManager;
+    resourceGroupManager: AzureResourceGroupManager;
+    resourceNameFormatter: AzureResourceNameFormatter;
+    securityCentermanager: AzureSecurityCentermanager;
+    serviceBusManager: AzureServiceBusManager;
+    storageManager: AzureStorageManager;
+    commonLogAnalyticsWorkspace: Workspace | Output<GetWorkspaceResult>;
+    constructor(name: string, props: CommonAzureStackProps, options?: ComponentResourceOptions);
+    protected resolveStack(stackName: string): pulumi.StackReference;
+    protected createResourceGroup(): void;
+    protected resolveCommonLogAnalyticsWorkspace(): void;
+    /**
+     * @summary Determine the fully qualified domain name based on domainName & subDomain
+     */
+    protected 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
+     */
+    isDevelopmentStage: () => boolean;
+    /**
+     * @summary Utility method to determine if the initialisation is in test (tst) stage
+     * This is determined by the stage property injected via cdk context
+     */
+    isTestStage: () => boolean;
+    /**
+     * @summary Utility method to determine if the initialisation is in uat (uat) stage
+     * This is determined by the stage property injected via cdk context
+     */
+    isUatStage: () => boolean;
+    /**
+     * @summary Utility method to determine if the initialisation is in production (prd) stage
+     * This is determined by the stage property injected via cdk context
+     */
+    isProductionStage: () => boolean;
+}

package/dist/src/common/construct.js

@@ -0,0 +1,128 @@
+import { getWorkspaceOutput } from '@pulumi/azure-native/operationalinsights/index.js';
+import * as pulumi from '@pulumi/pulumi';
+import { ComponentResource } from '@pulumi/pulumi';
+import { isDevStage, isPrdStage, isTestStage, isUatStage } from '@gradientedge/cdk-utils-common';
+import { AzureAuthorisationManager } from '../services/authorisation/main.js';
+import { AzureApiManagementManager, AzureAppConfigurationManager, AzureApplicationInsightsManager, AzureAppServiceManager, AzureCosmosDbManager, AzureDnsManager, AzureEventgridManager, AzureFunctionManager, AzureKeyVaultManager, AzureMonitorManager, AzureOperationalInsightsManager, AzurePortalManager, AzureRedisManager, AzureResourceGroupManager, AzureSecurityCentermanager, AzureServiceBusManager, AzureStorageManager, } from '../services/index.js';
+import { AzureResourceNameFormatter } from './resource-name-formatter.js';
+/**
+ * @classdesc Common Azure construct to use as a base for all higher level constructs using Pulumi
+ * - Provides manager instances for all Azure services
+ * - Handles resource naming conventions
+ * - Manages common properties and utilities
+ * @example
+ * ```typescript
+ * import { CommonAzureConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(name: string, props: CommonAzureStackProps) {
+ *     super(name, props)
+ *     // provision resources using this.resourceGroupManager, etc.
+ *   }
+ * }
+ * ```
+ */
+export class CommonAzureConstruct extends ComponentResource {
+    id;
+    resourceGroup;
+    fullyQualifiedDomainName;
+    authorisationManager;
+    apiManagementManager;
+    appConfigurationManager;
+    appServiceManager;
+    applicationInsightsManager;
+    cosmosDbManager;
+    dnsManager;
+    eventgridManager;
+    functionManager;
+    keyVaultManager;
+    operationalInsightsManager;
+    portalManager;
+    monitorManager;
+    redisManager;
+    resourceGroupManager;
+    resourceNameFormatter;
+    securityCentermanager;
+    serviceBusManager;
+    storageManager;
+    commonLogAnalyticsWorkspace;
+    constructor(name, props, options) {
+        super(`azure:${name}`, name, props, options);
+        this.props = props;
+        this.options = options;
+        this.id = name;
+        this.authorisationManager = new AzureAuthorisationManager();
+        this.apiManagementManager = new AzureApiManagementManager();
+        this.appConfigurationManager = new AzureAppConfigurationManager();
+        this.appServiceManager = new AzureAppServiceManager();
+        this.applicationInsightsManager = new AzureApplicationInsightsManager();
+        this.cosmosDbManager = new AzureCosmosDbManager();
+        this.dnsManager = new AzureDnsManager();
+        this.eventgridManager = new AzureEventgridManager();
+        this.functionManager = new AzureFunctionManager();
+        this.keyVaultManager = new AzureKeyVaultManager();
+        this.operationalInsightsManager = new AzureOperationalInsightsManager();
+        this.portalManager = new AzurePortalManager();
+        this.monitorManager = new AzureMonitorManager();
+        this.redisManager = new AzureRedisManager();
+        this.resourceGroupManager = new AzureResourceGroupManager();
+        this.resourceNameFormatter = new AzureResourceNameFormatter(props);
+        this.securityCentermanager = new AzureSecurityCentermanager();
+        this.serviceBusManager = new AzureServiceBusManager();
+        this.storageManager = new AzureStorageManager();
+        this.determineFullyQualifiedDomain();
+    }
+    resolveStack(stackName) {
+        if (!stackName)
+            throw 'Stack name undefined';
+        return new pulumi.StackReference(stackName);
+    }
+    createResourceGroup() {
+        if (this.resourceGroup)
+            return;
+        this.resourceGroup = this.resourceGroupManager.createResourceGroup(`${this.id}`, this, {
+            resourceGroupName: this.props.stackName,
+            location: this.props.location,
+        });
+        this.registerOutputs({
+            resourceGroupId: this.resourceGroup.id,
+            resourceGroupName: this.resourceGroup.name,
+        });
+    }
+    resolveCommonLogAnalyticsWorkspace() {
+        if (!this.props.commonLogAnalyticsWorkspace || !this.props.commonLogAnalyticsWorkspace.workspaceName)
+            throw 'Props undefined for commonLogAnalyticsWorkspace';
+        this.commonLogAnalyticsWorkspace = getWorkspaceOutput({
+            workspaceName: this.props.commonLogAnalyticsWorkspace.workspaceName,
+            resourceGroupName: this.props.commonLogAnalyticsWorkspace.resourceGroupName,
+        });
+    }
+    /**
+     * @summary Determine the fully qualified domain name based on domainName & subDomain
+     */
+    determineFullyQualifiedDomain() {
+        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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    isProductionStage = () => isPrdStage(this.props.stage);
+}

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

@@ -0,0 +1,6 @@
+export * from './constants.js';
+export * from './construct.js';
+export * from './resource-name-formatter.js';
+export * from './stack.js';
+export * from './tagging.js';
+export * from './types.js';

package/dist/src/common/index.js

@@ -0,0 +1,6 @@
+export * from './constants.js';
+export * from './construct.js';
+export * from './resource-name-formatter.js';
+export * from './stack.js';
+export * from './tagging.js';
+export * from './types.js';

package/dist/src/common/resource-name-formatter.d.ts

@@ -0,0 +1,18 @@
+import { AzureResourceNameFormatterProps, CommonAzureStackProps } from '../index.js';
+/**
+ * @classdesc Formats Azure resource names according to naming conventions
+ * - Applies global/resource prefixes and suffixes
+ * - Automatically appends stage to resource names
+ * - Supports per-resource customization via options
+ */
+export declare class AzureResourceNameFormatter {
+    props: CommonAzureStackProps;
+    constructor(props: CommonAzureStackProps);
+    /**
+     * @summary Helper method to format azure resource name based on the provided options
+     * @param resourceName The azure resource name to format
+     * @param options Options to control the formatting of the resource name
+     * @returns The formatted Azure-compliant resource name
+     */
+    format(resourceName: string | undefined, options?: AzureResourceNameFormatterProps): string;
+}

package/dist/src/common/resource-name-formatter.js

@@ -0,0 +1,34 @@
+/**
+ * @classdesc Formats Azure resource names according to naming conventions
+ * - Applies global/resource prefixes and suffixes
+ * - Automatically appends stage to resource names
+ * - Supports per-resource customization via options
+ */
+export class AzureResourceNameFormatter {
+    props;
+    constructor(props) {
+        this.props = props;
+    }
+    /**
+     * @summary Helper method to format azure resource name based on the provided options
+     * @param resourceName The azure resource name to format
+     * @param options Options to control the formatting of the resource name
+     * @returns The formatted Azure-compliant resource name
+     */
+    format(resourceName, options) {
+        const azureResourceNameElements = [];
+        if (!options?.exclude) {
+            azureResourceNameElements.push(options?.globalPrefix ? this.props.globalPrefix : undefined);
+            azureResourceNameElements.push(options?.prefix ?? this.props.resourcePrefix);
+        }
+        azureResourceNameElements.push(resourceName || '');
+        if (!options?.exclude) {
+            azureResourceNameElements.push(options?.suffix ?? this.props.resourceSuffix);
+            azureResourceNameElements.push(options?.globalSuffix ? this.props.globalSuffix : undefined);
+        }
+        azureResourceNameElements.push(this.props.stage);
+        return azureResourceNameElements
+            .filter(azureResourceNameElements => azureResourceNameElements != undefined)
+            .join('-');
+    }
+}

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

@@ -0,0 +1,46 @@
+import { ComponentResource, ComponentResourceOptions, Config } from '@pulumi/pulumi';
+import { CommonAzureConstruct } from './construct.js';
+import { CommonAzureStackProps } from './types.js';
+/**
+ * @classdesc Common stack to use as a base for all higher level constructs using Pulumi
+ * @example
+ * ```typescript
+ * import { CommonAzureStack } from '@gradientedge/cdk-utils'
+ *
+ * class CustomStack extends CommonAzureStack {
+ *   constructor(name: string, props: CommonAzureStackProps) {
+ *     super(name, props)
+ *     // provision resources
+ *   }
+ * }
+ * ```
+ */
+export declare class CommonAzureStack extends ComponentResource {
+    static NODEJS_RUNTIME: string;
+    construct: CommonAzureConstruct;
+    props: CommonAzureStackProps;
+    config: Config;
+    constructor(name: string, props: CommonAzureStackProps, options?: ComponentResourceOptions);
+    /**
+     * @summary Method to determine the core construct properties injected via context
+     * @param props The stack properties
+     * @returns The stack properties
+     */
+    protected determineConstructProps(props: CommonAzureStackProps): any;
+    /**
+     * @summary Method to determine extra contexts apart from the main context
+     * - Sets the properties from the extra contexts
+     * - Primary use is to have layered config in separate files to enable easier maintenance and readability
+     */
+    protected determineExtraContexts(): Record<string, any>;
+    /**
+     * @summary Method to determine extra stage contexts apart from the main context
+     * - Sets the properties from the extra stage contexts
+     * - Primary use is to have layered config for each environment which is injected into the context
+     */
+    protected determineStageContexts(): any;
+    /**
+     * @summary Determine the fully qualified domain name based on domainName & subDomain
+     */
+    protected fullyQualifiedDomain(): string;
+}

package/dist/src/common/stack.js

@@ -0,0 +1,120 @@
+import { ComponentResource, Config } from '@pulumi/pulumi';
+import appRoot from 'app-root-path';
+import fs from 'fs';
+import _ from 'lodash';
+import path from 'path';
+import { isDevStage } from '@gradientedge/cdk-utils-common';
+import { registerTagTransformation } from './tagging.js';
+/**
+ * @classdesc Common stack to use as a base for all higher level constructs using Pulumi
+ * @example
+ * ```typescript
+ * import { CommonAzureStack } from '@gradientedge/cdk-utils'
+ *
+ * class CustomStack extends CommonAzureStack {
+ *   constructor(name: string, props: CommonAzureStackProps) {
+ *     super(name, props)
+ *     // provision resources
+ *   }
+ * }
+ * ```
+ */
+export class CommonAzureStack extends ComponentResource {
+    static NODEJS_RUNTIME = '22';
+    construct;
+    props;
+    config;
+    constructor(name, props, options) {
+        super(`custom:azure:Stack:${name}`, name, props, options);
+        /* initialise config */
+        this.config = new Config();
+        this.props = this.determineConstructProps(props);
+        /* register tag transformation for automatic tag application */
+        if (this.props.defaultTags) {
+            registerTagTransformation(this.props.defaultTags);
+        }
+    }
+    /**
+     * @summary Method to determine the core construct properties injected via context
+     * @param props The stack properties
+     * @returns The stack properties
+     */
+    determineConstructProps(props) {
+        return {
+            ...props,
+            extraContexts: this.config.getObject('extraContexts'),
+            stage: this.config.require('stage'),
+            stageContextPath: this.config.require('stageContextPath'),
+            ...this.determineExtraContexts(),
+            ...this.determineStageContexts(),
+        };
+    }
+    /**
+     * @summary Method to determine extra contexts apart from the main context
+     * - Sets the properties from the extra contexts
+     * - Primary use is to have layered config in separate files to enable easier maintenance and readability
+     */
+    determineExtraContexts() {
+        const extraContexts = this.config.getObject('extraContexts');
+        const debug = this.config.getBoolean('debug');
+        if (!extraContexts) {
+            if (debug)
+                console.debug(`No additional contexts provided. Using default context properties`);
+            return {};
+        }
+        let extraContextProps = {};
+        _.forEach(extraContexts, (context) => {
+            const extraContextPath = path.join(appRoot.path, context);
+            /* scenario where extra context is configured 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 */
+            extraContextProps = {
+                ...extraContextProps,
+                ...JSON.parse(extraContextPropsBuffer.toString('utf-8')),
+            };
+        });
+        return extraContextProps;
+    }
+    /**
+     * @summary Method to determine extra stage contexts apart from the main context
+     * - Sets the properties from the extra stage contexts
+     * - Primary use is to have layered config for each environment which is injected into the context
+     */
+    determineStageContexts() {
+        const debug = this.config.getBoolean('debug');
+        const stage = this.config.require('stage');
+        const stageContextPath = this.config.get('stageContextPath');
+        const stageContextFilePath = path.join(appRoot.path, stageContextPath ?? 'env', `${stage}.json`);
+        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 */
+        return JSON.parse(stageContextPropsBuffer.toString('utf-8'));
+    }
+    /**
+     * @summary Determine the fully qualified domain name based on domainName & subDomain
+     */
+    fullyQualifiedDomain() {
+        const domainName = this.props.domainName;
+        const subDomain = this.props.subDomain;
+        return subDomain ? `${subDomain}.${domainName}` : domainName;
+    }
+}

package/dist/src/common/tagging.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @summary Check if a resource type is taggable
+ * @param resourceType The Pulumi resource type (e.g., 'azure-native:resources:ResourceGroup')
+ * @returns True if the resource supports tags, false otherwise
+ */
+export declare function isTaggableResource(resourceType: string): boolean;
+/**
+ * @summary Register a stack transformation to automatically apply tags to Azure resources
+ * @param defaultTags The default tags to apply to all resources
+ * @param tagsToIgnore Optional list of tag keys to ignore in lifecycle management
+ * @example
+ * ```typescript
+ * registerTagTransformation({ environment: 'production', team: 'platform' })
+ * ```
+ */
+export declare function registerTagTransformation(defaultTags: Record<string, string>, tagsToIgnore?: string[]): void;
+/**
+ * @summary Helper function to apply tags to a specific resource's properties
+ * @param props The resource properties
+ * @param defaultTags The default tags to merge with existing tags
+ * @returns The properties with merged tags
+ * @example
+ * ```typescript
+ * const resourceGroupProps = applyTags(props, { environment: 'dev' })
+ * ```
+ */
+export declare function applyTags<T extends {
+    tags?: Record<string, string>;
+}>(props: T, defaultTags: Record<string, string>): T;