@gradientedge/cdk-utils 10.0.0 → 10.2.0

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

@@ -89,7 +89,7 @@ export class CommonCloudflareStack extends ComponentResource {
      * - Primary use is to have layered config for each environment which is injected into the context
      */
     determineStageContexts(props) {
-        const stageContextFilePath = path.join(appRoot.path, props.stageContextPath ?? 'cdkEnv', `${props.stage}.json`);
+        const stageContextFilePath = path.join(appRoot.path, props.stageContextPath ?? 'env', `${props.stage}.json`);
         if (isDevStage(props.stage)) {
             if (props.debug)
                 console.debug(`Development stage. Using default stage context properties`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "10.0.0",
+  "version": "10.2.0",
   "description": "Utilities for AWS CDK provisioning",
   "type": "module",
   "main": "dist/index.js",
@@ -14,7 +14,7 @@
     "node": ">=22 <=24",
     "pnpm": "=10"
   },
-  "packageManager": "pnpm@10.26.0",
+  "packageManager": "pnpm@10.28.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gradientedge/cdk-utils.git"
@@ -55,27 +55,28 @@
     "prepare": "husky"
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.953.0",
-    "@aws-sdk/credential-providers": "^3.953.0",
-    "@aws-sdk/types": "^3.953.0",
+    "@aws-sdk/client-secrets-manager": "^3.975.0",
+    "@aws-sdk/credential-providers": "^3.975.0",
+    "@aws-sdk/types": "^3.973.1",
     "@cdktf/provider-aws": "^21.22.1",
     "@cdktf/provider-azurerm": "^14.23.1",
     "@cdktf/provider-cloudflare": "^13.9.1",
-    "@pulumi/aws": "^7.14.0",
-    "@pulumi/azure-native": "^3.11.0",
-    "@pulumi/cloudflare": "^6.11.0",
+    "@pulumi/aws": "^7.16.0",
+    "@pulumi/azure": "^6.31.0",
+    "@pulumi/azure-native": "^3.12.1",
+    "@pulumi/cloudflare": "^6.13.0",
     "@pulumi/command": "^1.1.3",
-    "@pulumi/pulumi": "^3.213.0",
+    "@pulumi/pulumi": "^3.217.1",
     "@pulumi/std": "^2.2.0",
-    "@types/lodash": "^4.17.21",
-    "@types/node": "^25.0.3",
+    "@types/lodash": "^4.17.23",
+    "@types/node": "^25.0.10",
     "@types/uuid": "^11.0.0",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.232.2",
+    "aws-cdk-lib": "^2.236.0",
     "cdktf": "^0.21.0",
     "cdktf-local-exec": "^0.6.28",
-    "constructs": "^10.4.4",
-    "lodash": "^4.17.21",
+    "constructs": "^10.4.5",
+    "lodash": "^4.17.23",
     "moment": "^2.30.1",
     "nconf": "^0.13.0",
     "pluralize": "^8.0.0",
@@ -83,16 +84,16 @@
     "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.28.5",
-    "@babel/eslint-parser": "^7.28.5",
+    "@babel/core": "^7.28.6",
+    "@babel/eslint-parser": "^7.28.6",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@eslint/config-array": "^0.23.0",
     "@eslint/object-schema": "^3.0.0",
-    "@types/node": "^25.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.50.0",
-    "@typescript-eslint/parser": "^8.50.0",
-    "@vitest/coverage-v8": "^2.1.8",
-    "aws-cdk": "^2.1100.1",
+    "@types/node": "^25.0.10",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "aws-cdk": "^2.1103.0",
     "better-docs": "^2.7.3",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.1",
@@ -102,25 +103,25 @@
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsdoc": "^61.5.0",
+    "eslint-plugin-jsdoc": "^62.4.1",
     "husky": "^9.1.7",
     "jsdoc": "^4.0.5",
     "jsdoc-babel": "^0.5.0",
     "jsdoc-mermaid": "^1.0.0",
     "jsdoc-plugin-typescript": "^3.2.0",
     "jsdoc-to-markdown": "^9.1.3",
-    "prettier": "^3.7.4",
+    "prettier": "^3.8.1",
     "prettier-plugin-organize-imports": "^4.3.0",
     "rimraf": "^6.1.2",
-    "rollup": "^4.53.5",
+    "rollup": "^4.57.0",
     "semantic-release": "^25.0.2",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/github": "^11.0.0",
-    "@semantic-release/npm": "^13.0.0",
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.3",
     "taffydb": "^2.7.3",
     "ts-node": "^10.9.2",
     "typescript": "5.9.3",
-    "vitest": "^2.1.8",
+    "vitest": "^4.0.18",
     "yaml": "^2.8.2"
   },
   "optionalDependencies": {

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

@@ -1,6 +1,7 @@
 export enum AzureRemoteBackend {
-  local = 'local',
   azurerm = 'azurerm',
+  pulumi = 'pulumi',
+  local = 'local',
 }
 
 /**

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

@@ -1,8 +1,4 @@
-import { DataAzurermClientConfig } from '@cdktf/provider-azurerm/lib/data-azurerm-client-config/index.js'
-import { AzurermProvider } from '@cdktf/provider-azurerm/lib/provider/index.js'
-import { AzurermBackend, TerraformStack } from 'cdktf'
-import { Provider } from 'cdktf-local-exec'
-import { Construct } from 'constructs'
+import { ComponentResource, ComponentResourceOptions } from '@pulumi/pulumi'
 import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common/index.js'
 import {
   AzureApiManagementManager,
@@ -14,19 +10,38 @@ import {
   AzureEventgridManager,
   AzureFunctionManager,
   AzureKeyVaultManager,
-  AzureLogAnalyticsWorkspaceManager,
+  AzureOperationalInsightsManager,
   AzureMonitorManager,
   AzureRedisManager,
   AzureResourceGroupManager,
   AzureServicebusManager,
   AzureStorageManager,
 } from '../services/index.js'
-import { AzureRemoteBackend } from './constants.js'
 import { AzureResourceNameFormatter } from './resource-name-formatter.js'
 import { CommonAzureStackProps } from './types.js'
 
-export class CommonAzureConstruct extends TerraformStack {
+/**
+ * @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 {
   declare props: CommonAzureStackProps
+  declare options?: ComponentResourceOptions
+  id: string
+  fullyQualifiedDomainName: string
   apiManagementManager: AzureApiManagementManager
   appConfigurationManager: AzureAppConfigurationManager
   appServiceManager: AzureAppServiceManager
@@ -34,23 +49,21 @@ export class CommonAzureConstruct extends TerraformStack {
   cosmosDbManager: AzureCosmosDbManager
   dnsManager: AzureDnsManager
   eventgridManager: AzureEventgridManager
-  fullyQualifiedDomainName: string
-  functiontManager: AzureFunctionManager
-  id: string
+  functionManager: AzureFunctionManager
   keyVaultManager: AzureKeyVaultManager
-  logAnalyticsWorkspaceManager: AzureLogAnalyticsWorkspaceManager
+  operationalInsightsManager: AzureOperationalInsightsManager
   monitorManager: AzureMonitorManager
   redisManager: AzureRedisManager
   resourceGroupManager: AzureResourceGroupManager
   resourceNameFormatter: AzureResourceNameFormatter
   servicebusManager: AzureServicebusManager
   storageManager: AzureStorageManager
-  tenantId: string
 
-  constructor(scope: Construct, id: string, props: CommonAzureStackProps) {
-    super(scope, id)
+  constructor(name: string, props: CommonAzureStackProps, options?: ComponentResourceOptions) {
+    super(`custom:azure:Construct:${name}`, name, props, options)
     this.props = props
-    this.id = id
+    this.options = options
+    this.id = name
 
     this.apiManagementManager = new AzureApiManagementManager()
     this.appConfigurationManager = new AzureAppConfigurationManager()
@@ -59,22 +72,17 @@ export class CommonAzureConstruct extends TerraformStack {
     this.cosmosDbManager = new AzureCosmosDbManager()
     this.dnsManager = new AzureDnsManager()
     this.eventgridManager = new AzureEventgridManager()
-    this.functiontManager = new AzureFunctionManager()
+    this.functionManager = new AzureFunctionManager()
     this.keyVaultManager = new AzureKeyVaultManager()
-    this.logAnalyticsWorkspaceManager = new AzureLogAnalyticsWorkspaceManager()
+    this.operationalInsightsManager = new AzureOperationalInsightsManager()
     this.monitorManager = new AzureMonitorManager()
     this.redisManager = new AzureRedisManager()
     this.resourceGroupManager = new AzureResourceGroupManager()
-    this.resourceNameFormatter = new AzureResourceNameFormatter(this, `${id}-rnf`, props)
+    this.resourceNameFormatter = new AzureResourceNameFormatter(props)
     this.servicebusManager = new AzureServicebusManager()
     this.storageManager = new AzureStorageManager()
 
     this.determineFullyQualifiedDomain()
-    this.determineRemoteBackend()
-    this.determineTenantId()
-
-    new AzurermProvider(this, `${this.id}-provider`, this.props)
-    new Provider(this, `${this.id}-local-exec-provider`)
   }
 
   /**
@@ -86,30 +94,6 @@ export class CommonAzureConstruct extends TerraformStack {
       : this.props.domainName
   }
 
-  protected determineRemoteBackend() {
-    const debug = this.node.tryGetContext('debug')
-    switch (this.props.remoteBackend?.type) {
-      case AzureRemoteBackend.azurerm:
-        new AzurermBackend(this, {
-          storageAccountName: this.props.remoteBackend.storageAccountName,
-          containerName: this.props.remoteBackend.containerName,
-          key: `${this.id}`,
-          subscriptionId: this.props.subscriptionId,
-          resourceGroupName: this.props.remoteBackend.resourceGroupName,
-        })
-        break
-      case AzureRemoteBackend.local:
-        if (debug) console.debug(`Using local backend for ${this.id}`)
-        break
-      default:
-        break
-    }
-  }
-
-  protected determineTenantId() {
-    this.tenantId = new DataAzurermClientConfig(this, 'current', {}).tenantId
-  }
-
   /**
    * @summary Utility method to determine if the initialisation is in development (dev) stage
    * This is determined by the stage property injected via cdk context

package/src/lib/azure/common/resource-name-formatter.ts

@@ -1,11 +1,15 @@
-import { Construct } from 'constructs'
 import { AzureResourceNameFormatterProps, CommonAzureStackProps } from '../index.js'
 
-export class AzureResourceNameFormatter extends Construct {
+/**
+ * @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: CommonAzureStackProps
 
-  constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
-    super(parent, id)
+  constructor(props: CommonAzureStackProps) {
     this.props = props
   }
 
@@ -15,7 +19,7 @@ export class AzureResourceNameFormatter extends Construct {
    * @param options Options to control the formatting of the resource name
    * @returns The formatted Azure-compliant resource name
    */
-  public format(resourceName: string, options?: AzureResourceNameFormatterProps) {
+  public format(resourceName: string | undefined, options?: AzureResourceNameFormatterProps): string {
     const azureResourceNameElements = []
 
     if (!options?.exclude) {
@@ -23,7 +27,7 @@ export class AzureResourceNameFormatter extends Construct {
       azureResourceNameElements.push(options?.prefix ?? this.props.resourcePrefix)
     }
 
-    azureResourceNameElements.push(resourceName)
+    azureResourceNameElements.push(resourceName || '')
 
     if (!options?.exclude) {
       azureResourceNameElements.push(options?.suffix ?? this.props.resourceSuffix)

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

@@ -1,150 +1,150 @@
+import { ComponentResource, ComponentResourceOptions, Config } from '@pulumi/pulumi'
 import appRoot from 'app-root-path'
-import { Aspects, TerraformStack } from 'cdktf'
-import { Construct } from 'constructs'
 import fs from 'fs'
 import _ from 'lodash'
 import path from 'path'
 import { isDevStage } from '../../common/index.js'
 import { CommonAzureConstruct } from './construct.js'
-import { TagsAddingAspect } from './tagging.js'
+import { registerTagTransformation } from './tagging.js'
 import { CommonAzureStackProps } from './types.js'
 
 /**
- * @classdesc Common stack to use as a base for all higher level constructs.
+ * @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(parent: App, name: string, props: StackProps) {
- *     super(parent, name, props)
+ *   constructor(name: string, props: CommonAzureStackProps) {
+ *     super(name, props)
  *     // provision resources
  *   }
  * }
+ * ```
  */
-export class CommonAzureStack extends TerraformStack {
+export class CommonAzureStack extends ComponentResource {
   construct: CommonAzureConstruct
   props: CommonAzureStackProps
+  config: Config
 
-  constructor(parent: Construct, name: string, props: CommonAzureStackProps) {
-    super(parent, name)
-
-    /* determine extra cdk contexts */
-    this.determineExtraContexts()
-
-    /* determine extra cdk stage contexts */
-    this.determineStageContexts()
+  constructor(name: string, props: CommonAzureStackProps, options?: ComponentResourceOptions) {
+    super(`custom:azure:Stack:${name}`, name, props, options)
 
+    /* initialise config */
+    this.config = new Config()
     this.props = this.determineConstructProps(props)
 
-    Aspects.of(this).add(new TagsAddingAspect(this.props.defaultTags || {}))
+    /* register tag transformation for automatic tag application */
+    if (this.props.defaultTags) {
+      registerTagTransformation(this.props.defaultTags)
+    }
   }
 
   /**
-   * @summary Method to determine the core CDK construct properties injected via context cdktf.json
+   * @summary Method to determine the core construct properties injected via context
    * @param props The stack properties
    * @returns The stack properties
    */
   protected determineConstructProps(props: CommonAzureStackProps) {
+    let projectProps: CommonAzureStackProps = props
+    if (!projectProps) {
+      const projectPropsPath = path.join(appRoot.path, 'pulumi.json')
+      if (!fs.existsSync(projectPropsPath)) throw `Context properties unavailable in path:${projectPropsPath}`
+
+      const projectPropsBuffer = fs.readFileSync(projectPropsPath)
+      projectProps = JSON.parse(projectPropsBuffer.toString('utf-8'))
+    }
+
     return {
-      domainName: this.node.tryGetContext('domainName'),
-      extraContexts: this.node.tryGetContext('extraContexts'),
-      features: this.node.tryGetContext('features'),
-      location: this.node.tryGetContext('location'),
-      name: this.node.tryGetContext('resourceGroupName'),
-      resourceGroupName: this.node.tryGetContext('resourceGroupName'),
-      globalPrefix: this.node.tryGetContext('globalPrefix'),
-      globalSuffix: this.node.tryGetContext('globalSuffix'),
-      resourceNameOptions: this.node.tryGetContext('resourceNameOptions'),
-      resourcePrefix: this.node.tryGetContext('resourcePrefix'),
-      resourceSuffix: this.node.tryGetContext('resourceSuffix'),
-      skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
-      stage: this.node.tryGetContext('stage'),
-      subDomain: this.node.tryGetContext('subDomain'),
-      subscriptionId: this.node.tryGetContext('subscriptionId'),
+      domainName: projectProps.domainName,
+      extraContexts: projectProps.extraContexts,
+      location: projectProps.location,
+      name: projectProps.resourceGroupName ?? projectProps.name,
+      resourceGroupName: projectProps.resourceGroupName,
+      globalPrefix: projectProps.globalPrefix,
+      globalSuffix: projectProps.globalSuffix,
+      resourceNameOptions: projectProps.resourceNameOptions,
+      resourcePrefix: projectProps.resourcePrefix,
+      resourceSuffix: projectProps.resourceSuffix,
+      skipStageForARecords: projectProps.skipStageForARecords,
+      stage: projectProps.stage,
+      stageContextPath: projectProps.stageContextPath,
+      subDomain: projectProps.subDomain,
+      subscriptionId: projectProps.subscriptionId,
+      tenantId: projectProps.tenantId,
+      clientId: projectProps.clientId,
+      clientSecret: projectProps.clientSecret,
+      defaultTags: projectProps.defaultTags,
+      ...this.determineExtraContexts(props),
+      ...this.determineStageContexts(props),
     }
   }
 
   /**
-   * @summary Method to determine extra cdk contexts apart from the main cdktf.json
-   * - Sets the properties from the extra contexts into cdk node context
+   * @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() {
-    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
+  protected determineExtraContexts(props: CommonAzureStackProps) {
+    if (!props.extraContexts) {
+      if (props.debug) console.debug(`No additional contexts provided. Using default context properties`)
+      return {}
     }
 
-    _.forEach(extraContexts, (context: string) => {
+    let extraContextProps: Record<string, any> = {}
+    _.forEach(props.extraContexts, (context: string) => {
       const extraContextPath = path.join(appRoot.path, context)
 
-      /* scenario where extra context is configured in cdk.json but absent in file system */
+      /* 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}`)
+      if (props.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])
-      })
+      extraContextProps = {
+        ...extraContextProps,
+        ...JSON.parse(extraContextPropsBuffer.toString('utf-8')),
+      }
     })
+    return extraContextProps
   }
 
   /**
-   * @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
+   * @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() {
-    const stage = process.env.STAGE ?? this.node.tryGetContext('stage')
-    const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv'
-    const stageContextFilePath = path.join(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`)
+  protected determineStageContexts(props: CommonAzureStackProps) {
+    const stageContextFilePath = path.join(appRoot.path, props.stageContextPath ?? 'env', `${props.stage}.json`)
+
+    if (isDevStage(props.stage)) {
+      if (props.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
+      if (props.debug) console.debug(`Stage specific context properties unavailable in path:${stageContextFilePath}`)
+      if (props.debug) console.debug(`Using default stage context properties for ${props.stage} stage`)
+      return {}
     }
 
     /* read the extra properties */
     const stageContextPropsBuffer = fs.readFileSync(stageContextFilePath)
-    if (debug) console.debug(`Adding additional stage contexts provided in ${stageContextFilePath}`)
+    if (props.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])
-      }
-    })
+    return JSON.parse(stageContextPropsBuffer.toString('utf-8'))
   }
 
   /**
    * @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')
+    const domainName = this.props.domainName
+    const subDomain = this.props.subDomain
+
     return subDomain ? `${subDomain}.${domainName}` : domainName
   }
 }