@gradientedge/cdk-utils 4.1.2 → 4.2.3

package/src/lib/manager/{route53Manager.ts → aws/route53Manager.ts}

@@ -2,20 +2,20 @@ import * as apig from 'aws-cdk-lib/aws-apigateway'
 import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
 import * as route53 from 'aws-cdk-lib/aws-route53'
 import * as route53Targets from 'aws-cdk-lib/aws-route53-targets'
-import { Route53Props } from '../types'
-import { CommonConstruct } from '../common/commonConstruct'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Networking & Content Delivery
  * @summary Provides operations on AWS Route53.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -29,10 +29,10 @@ export class Route53Manager {
   /**
    * @summary Method to create a hosted zone
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {Route53Props} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.Route53Props} props
    */
-  public createHostedZone(id: string, scope: CommonConstruct, props: Route53Props) {
+  public createHostedZone(id: string, scope: common.CommonConstruct, props: types.Route53Props) {
     let hostedZone: route53.IHostedZone
 
     if (!props) throw `Route53 props undefined`
@@ -48,8 +48,8 @@ export class Route53Manager {
       })
     }
 
-    createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
-    createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
+    utils.createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
+    utils.createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
 
     return hostedZone
   }
@@ -57,12 +57,12 @@ export class Route53Manager {
   /**
    * @summary Method to create/lookup a hosted zone
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param useExistingHostedZone Flag to indicate whether to lookup vs create new hosted zone
    */
   public withHostedZoneFromFullyQualifiedDomainName(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     useExistingHostedZone: boolean
   ) {
     let hostedZone: route53.IHostedZone
@@ -78,8 +78,8 @@ export class Route53Manager {
       })
     }
 
-    createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
-    createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
+    utils.createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
+    utils.createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
 
     return hostedZone
   }
@@ -87,14 +87,14 @@ export class Route53Manager {
   /**
    * @summary Method to create a-record for cloudfront target
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {cloudfront.IDistribution} distribution
    * @param {route53.IHostedZone} hostedZone
    * @param {string} recordName
    */
   public createCloudFrontTargetARecord(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     distribution?: cloudfront.IDistribution,
     hostedZone?: route53.IHostedZone,
     recordName?: string
@@ -108,7 +108,7 @@ export class Route53Manager {
       zone: hostedZone,
     })
 
-    createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
+    utils.createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
 
     return aRecord
   }
@@ -116,14 +116,14 @@ export class Route53Manager {
   /**
    * @summary Method to create a-record for cloudfront target
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {cloudfront.IDistribution} distribution
    * @param {route53.IHostedZone} hostedZone
    * @param {string} recordName
    */
   public createCloudFrontTargetARecordV2(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     distribution?: cloudfront.IDistribution,
     hostedZone?: route53.IHostedZone,
     recordName?: string
@@ -137,7 +137,7 @@ export class Route53Manager {
       zone: hostedZone,
     })
 
-    createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
+    utils.createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
 
     return aRecord
   }
@@ -145,14 +145,14 @@ export class Route53Manager {
   /**
    * @summary Method to create a-record for api gateway target
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param recordName
    * @param apiDomain
    * @param hostedZone
    */
   public createApiGatewayARecord(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     recordName: string,
     apiDomain: apig.DomainName,
     hostedZone: route53.IHostedZone
@@ -167,7 +167,7 @@ export class Route53Manager {
       zone: hostedZone,
     })
 
-    createCfnOutput(`${id}-a-record-domain-name`, scope, apiARecord.domainName)
+    utils.createCfnOutput(`${id}-a-record-domain-name`, scope, apiARecord.domainName)
 
     return apiARecord
   }

package/src/lib/manager/{s3Manager.ts → aws/s3Manager.ts}

@@ -3,20 +3,20 @@ import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment'
-import { CommonConstruct } from '../common/commonConstruct'
-import { LifecycleRule, S3BucketProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Storage
  * @summary Provides operations on AWS S3.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -29,13 +29,13 @@ import { createCfnOutput } from '../utils'
 export class S3Manager {
   /**
    * @summary Method to determine S3 Bucket lifecycle properties
-   * @param {S3BucketProps} props bucket properties
+   * @param {types.S3BucketProps} props bucket properties
    * @private
    */
-  protected determineBucketLifecycleRules(props: S3BucketProps) {
+  protected determineBucketLifecycleRules(props: types.S3BucketProps) {
     if (!props.lifecycleRules) return undefined
 
-    const bucketLifecycleRules: LifecycleRule[] = []
+    const bucketLifecycleRules: types.LifecycleRule[] = []
     props.lifecycleRules.forEach(lifecycleRule => {
       bucketLifecycleRules.push({
         id: lifecycleRule.id,
@@ -59,11 +59,11 @@ export class S3Manager {
 
   /**
    * @summary Method to determine the bucket name
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {S3BucketProps} props bucket properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.S3BucketProps} props bucket properties
    * @private
    */
-  protected static determineBucketName(scope: CommonConstruct, props: S3BucketProps) {
+  protected static determineBucketName(scope: common.CommonConstruct, props: types.S3BucketProps) {
     return scope.isProductionStage()
       ? `${props.bucketName}.${scope.fullyQualifiedDomainName}`
       : `${props.bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
@@ -71,11 +71,11 @@ export class S3Manager {
 
   /**
    * @summary Method to determine the log bucket name
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {S3BucketProps} props bucket properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.S3BucketProps} props bucket properties
    * @private
    */
-  protected static determineLogBucketName(scope: CommonConstruct, props: S3BucketProps) {
+  protected static determineLogBucketName(scope: common.CommonConstruct, props: types.S3BucketProps) {
     return scope.isProductionStage()
       ? `${props.logBucketName}.${scope.fullyQualifiedDomainName}`
       : `${props.logBucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
@@ -84,10 +84,10 @@ export class S3Manager {
   /**
    * @summary Method to create a s3 bucket
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {S3BucketProps} props bucket properties
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.S3BucketProps} props bucket properties
    */
-  public createS3Bucket(id: string, scope: CommonConstruct, props: S3BucketProps) {
+  public createS3Bucket(id: string, scope: common.CommonConstruct, props: types.S3BucketProps) {
     if (!props) throw `S3 props undefined`
 
     let bucket: s3.IBucket
@@ -131,8 +131,8 @@ export class S3Manager {
       }
     }
 
-    createCfnOutput(`${id}-bucketName`, scope, bucket.bucketName)
-    createCfnOutput(`${id}-bucketArn`, scope, bucket.bucketArn)
+    utils.createCfnOutput(`${id}-bucketName`, scope, bucket.bucketName)
+    utils.createCfnOutput(`${id}-bucketArn`, scope, bucket.bucketArn)
 
     return bucket
   }
@@ -140,10 +140,10 @@ export class S3Manager {
   /**
    * @summary Method to create an iam bucket policy for cloudtrail
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {s3.IBucket} bucket
    */
-  public createBucketPolicyForCloudTrail(id: string, scope: CommonConstruct, bucket: s3.IBucket) {
+  public createBucketPolicyForCloudTrail(id: string, scope: common.CommonConstruct, bucket: s3.IBucket) {
     const bucketPolicyDocument = new iam.PolicyDocument({
       statements: [
         new iam.PolicyStatement({
@@ -172,7 +172,7 @@ export class S3Manager {
   /**
    * @summary Method to create a s3 bucket deployment
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {s3.IBucket} siteBucket
    * @param {cloudfront.IDistribution} distribution
    * @param {s3deploy.ISource[]} sources
@@ -181,7 +181,7 @@ export class S3Manager {
    */
   public doBucketDeployment(
     id: string,
-    scope: CommonConstruct,
+    scope: common.CommonConstruct,
     siteBucket: s3.IBucket,
     distribution: cloudfront.IDistribution,
     sources: s3deploy.ISource[],

package/src/lib/manager/{secretsManager.ts → aws/secretsManager.ts}

@@ -1,6 +1,6 @@
-import { CommonConstruct } from '../common/commonConstruct'
 import * as cdk from 'aws-cdk-lib'
 import * as secretsManager from 'aws-cdk-lib/aws-secretsmanager'
+import * as common from '../../common'
 
 const AWS = require('aws-sdk')
 const fs = require('fs')
@@ -9,12 +9,12 @@ const fs = require('fs')
  * @stability experimental
  * @category Security, Identity & Compliance
  * @summary Provides operations on AWS Secrets Manager.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -100,7 +100,12 @@ export class SecretsManager {
    * @param stackName
    * @param exportName
    */
-  public retrieveSecretFromSecretsManager(id: string, scope: CommonConstruct, stackName: string, exportName: string) {
+  public retrieveSecretFromSecretsManager(
+    id: string,
+    scope: common.CommonConstruct,
+    stackName: string,
+    exportName: string
+  ) {
     return secretsManager.Secret.fromSecretNameV2(
       scope,
       `${id}`,

package/src/lib/manager/{snsManager.ts → aws/snsManager.ts}

@@ -1,20 +1,20 @@
 import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as sns from 'aws-cdk-lib/aws-sns'
 import * as subs from 'aws-cdk-lib/aws-sns-subscriptions'
-import { CommonConstruct } from '../common/commonConstruct'
-import { SubscriptionProps } from '../types'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Application Integration
  * @summary Provides operations on AWS Simple Notification Service.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -28,14 +28,14 @@ export class SnsManager {
   /**
    * @summary Method to create an email notification service
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {SubscriptionProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.SubscriptionProps} props
    * @param {string[]} emails
    */
   public createEmailNotificationService(
     id: string,
-    scope: CommonConstruct,
-    props: SubscriptionProps,
+    scope: common.CommonConstruct,
+    props: types.SubscriptionProps,
     emails: string[]
   ) {
     if (!props) throw `Subscription props undefined`
@@ -50,8 +50,8 @@ export class SnsManager {
       emails.forEach((email: string) => topic.addSubscription(new subs.EmailSubscription(email)))
     }
 
-    createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)
-    createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName)
+    utils.createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)
+    utils.createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName)
 
     return topic
   }
@@ -59,14 +59,14 @@ export class SnsManager {
   /**
    * @summary Method to create a lambda notification service
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {SubscriptionProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.SubscriptionProps} props
    * @param {lambda.Function} lambdaFunction
    */
   public createLambdaNotificationService(
     id: string,
-    scope: CommonConstruct,
-    props: SubscriptionProps,
+    scope: common.CommonConstruct,
+    props: types.SubscriptionProps,
     lambdaFunction: lambda.Function
   ) {
     if (!props) throw `Subscription props undefined`
@@ -79,8 +79,8 @@ export class SnsManager {
 
     topic.addSubscription(new subs.LambdaSubscription(lambdaFunction))
 
-    createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)
-    createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName)
+    utils.createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)
+    utils.createCfnOutput(`${id}-subscriptionName`, scope, topic.topicName)
 
     return topic
   }

package/src/lib/manager/{ssmManager.ts → aws/ssmManager.ts}

@@ -1,19 +1,19 @@
-import { CommonConstruct } from '../common/commonConstruct'
 import * as ssm from 'aws-cdk-lib/aws-ssm'
-import { createCfnOutput } from '../utils'
 import * as cr from 'aws-cdk-lib/custom-resources'
-import { SSMParameterReaderProps } from '../types'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Management & Governance
  * @summary Provides operations on AWS Systems Manager.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
+ * import { common.CommonConstruct } from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends CommonConstruct {
+ * class CustomConstruct extends common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -27,10 +27,10 @@ export class SsmManager {
   /**
    * Method to write a string parameter to the parameters store
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {ssm.StringParameterProps} props parameter props
    */
-  public writeStringToParameters(id: string, scope: CommonConstruct, props: ssm.StringParameterProps) {
+  public writeStringToParameters(id: string, scope: common.CommonConstruct, props: ssm.StringParameterProps) {
     if (!props) throw `Parameter props undefined`
 
     const parameter = new ssm.StringParameter(scope, `${id}`, {
@@ -39,8 +39,8 @@ export class SsmManager {
       stringValue: props.stringValue,
     })
 
-    createCfnOutput(`${id}-parameterArn`, scope, parameter.parameterArn)
-    createCfnOutput(`${id}-parameterName`, scope, parameter.parameterName)
+    utils.createCfnOutput(`${id}-parameterArn`, scope, parameter.parameterArn)
+    utils.createCfnOutput(`${id}-parameterName`, scope, parameter.parameterName)
 
     return parameter
   }
@@ -48,10 +48,10 @@ export class SsmManager {
   /**
    * Method to read a string parameter from the parameters store
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {string} parameterName parameter name to lookup
    */
-  public readStringParameter(id: string, scope: CommonConstruct, parameterName: string) {
+  public readStringParameter(id: string, scope: common.CommonConstruct, parameterName: string) {
     if (!parameterName || parameterName == '') throw 'Invalid parameter name'
 
     return ssm.StringParameter.fromStringParameterName(scope, `${id}`, parameterName).stringValue
@@ -60,11 +60,16 @@ export class SsmManager {
   /**
    * Method to read a string parameter from the parameters store in a given region
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {string} parameterName parameter name to lookup
    * @param {string} region region name to lookup parameter
    */
-  public readStringParameterFromRegion(id: string, scope: CommonConstruct, parameterName: string, region: string) {
+  public readStringParameterFromRegion(
+    id: string,
+    scope: common.CommonConstruct,
+    parameterName: string,
+    region: string
+  ) {
     if (!parameterName || parameterName == '') throw 'Invalid parameter name'
     if (!region || region == '') throw 'Invalid region'
 
@@ -81,11 +86,11 @@ export class SsmManager {
 export class SSMParameterReader extends cr.AwsCustomResource {
   /**
    *
-   * @param scope
-   * @param name
-   * @param props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {string} name parameter name
+   * @param {types.SSMParameterReaderProps} props
    */
-  constructor(scope: CommonConstruct, name: string, props: SSMParameterReaderProps) {
+  constructor(scope: common.CommonConstruct, name: string, props: types.SSMParameterReaderProps) {
     const { parameterName, region } = props
 
     const ssmAwsSdkCall: cr.AwsSdkCall = {

package/src/lib/manager/{vpcManager.ts → aws/vpcManager.ts}

@@ -1,7 +1,7 @@
 import * as cdk from 'aws-cdk-lib'
 import * as ec2 from 'aws-cdk-lib/aws-ec2'
-import { CommonConstruct } from '../common/commonConstruct'
-import { createCfnOutput } from '../utils'
+import * as common from '../../common'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
@@ -12,12 +12,12 @@ const CommonVpcIdentifier = 'CommonVpc'
 /**
  * @category Networking & Content Delivery
  * @summary Provides operations on AWS VPC.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -31,40 +31,40 @@ export class VpcManager {
   /**
    * @summary Method to create a new vpc
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {ec2.VpcProps} props
    */
-  public createVpc(id: string, scope: CommonConstruct, props: ec2.VpcProps) {
+  public createVpc(id: string, scope: common.CommonConstruct, props: ec2.VpcProps) {
     if (!props) throw 'Vpc props undefined'
     const vpc = new ec2.Vpc(scope, `${id}`, {
       maxAzs: props.maxAzs,
     })
 
-    createCfnOutput(`${id}Id`, scope, vpc.vpcId)
-    createCfnOutput(`${id}PublicSubnetIds`, scope, vpc.publicSubnets.map(subnet => subnet.subnetId).toString())
-    createCfnOutput(`${id}PrivateSubnetIds`, scope, vpc.privateSubnets.map(subnet => subnet.subnetId).toString())
-    createCfnOutput(
+    utils.createCfnOutput(`${id}Id`, scope, vpc.vpcId)
+    utils.createCfnOutput(`${id}PublicSubnetIds`, scope, vpc.publicSubnets.map(subnet => subnet.subnetId).toString())
+    utils.createCfnOutput(`${id}PrivateSubnetIds`, scope, vpc.privateSubnets.map(subnet => subnet.subnetId).toString())
+    utils.createCfnOutput(
       `${id}PublicSubnetRouteTableIds`,
       scope,
       vpc.publicSubnets.map(subnet => subnet.routeTable.routeTableId).toString()
     )
-    createCfnOutput(
+    utils.createCfnOutput(
       `${id}PrivateSubnetRouteTableIds`,
       scope,
       vpc.privateSubnets.map(subnet => subnet.routeTable.routeTableId).toString()
     )
-    createCfnOutput(`${id}AvailabilityZones`, scope, vpc.availabilityZones.toString())
+    utils.createCfnOutput(`${id}AvailabilityZones`, scope, vpc.availabilityZones.toString())
 
     return vpc
   }
 
   /**
    * @summary Method to create a common vpc
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {ec2.VpcProps} props
    * @param {string?} vpcIdentifier optional identifier for VPC
    */
-  public createCommonVpc(scope: CommonConstruct, props: ec2.VpcProps, vpcIdentifier?: string) {
+  public createCommonVpc(scope: common.CommonConstruct, props: ec2.VpcProps, vpcIdentifier?: string) {
     const vpc = this.createVpc(CommonVpcIdentifier, scope, props)
     cdk.Tags.of(vpc).add('Name', vpcIdentifier ?? CommonVpcIdentifier)
 
@@ -74,9 +74,9 @@ export class VpcManager {
   /**
    * @summary Method to retrieve a common vpc
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public retrieveCommonVpc(id: string, scope: CommonConstruct) {
+  public retrieveCommonVpc(id: string, scope: common.CommonConstruct) {
     return ec2.Vpc.fromLookup(scope, `${id}`, { vpcName: CommonVpcIdentifier })
   }
 }

package/src/lib/manager/{wafManager.ts → aws/wafManager.ts}

@@ -1,18 +1,18 @@
 import * as wafv2 from 'aws-cdk-lib/aws-wafv2'
-import { CommonConstruct } from '../common/commonConstruct'
-import { createCfnOutput } from '../utils'
-import { WafIPSetProps, WafWebACLProps } from '../types'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
 
 /**
  * @stability stable
  * @category Security, Identity & Compliance
  * @summary Provides operations on AWS WAF.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
  * @example
  * import * as common from '@gradientedge/cdk-utils'
  *
- * class CustomConstruct extends common.CommonConstruct {
+ * class CustomConstruct extends common.common.CommonConstruct {
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
@@ -26,10 +26,10 @@ export class WafManager {
   /**
    * @summary Method to create an ip set
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {WafIPSetProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.WafIPSetProps} props
    */
-  public createIpSet(id: string, scope: CommonConstruct, props: WafIPSetProps) {
+  public createIpSet(id: string, scope: common.CommonConstruct, props: types.WafIPSetProps) {
     if (!props) throw `WAF Ip Set props undefined`
 
     const ipSet = new wafv2.CfnIPSet(scope, `${id}`, {
@@ -40,8 +40,8 @@ export class WafManager {
       scope: props.scope,
     })
 
-    createCfnOutput(`${id}-ipSetId`, scope, ipSet.attrId)
-    createCfnOutput(`${id}-ipSetArn`, scope, ipSet.attrArn)
+    utils.createCfnOutput(`${id}-ipSetId`, scope, ipSet.attrId)
+    utils.createCfnOutput(`${id}-ipSetArn`, scope, ipSet.attrArn)
 
     return ipSet
   }
@@ -49,10 +49,10 @@ export class WafManager {
   /**
    * @summary Method to create a web acl
    * @param {string} id scoped id of the resource
-   * @param {CommonConstruct} scope scope in which this resource is defined
-   * @param {WafWebACLProps} props
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.WafWebACLProps} props
    */
-  public createWebAcl(id: string, scope: CommonConstruct, props: WafWebACLProps) {
+  public createWebAcl(id: string, scope: common.CommonConstruct, props: types.WafWebACLProps) {
     if (!props) throw `WAF WebACL props undefined`
 
     const webAcl = new wafv2.CfnWebACL(scope, `${id}`, {
@@ -65,8 +65,8 @@ export class WafManager {
       tags: [{ key: 'service', value: scope.props.name }],
     })
 
-    createCfnOutput(`${id}-webAclId`, scope, webAcl.attrId)
-    createCfnOutput(`${id}-webAclArn`, scope, webAcl.attrArn)
+    utils.createCfnOutput(`${id}-webAclId`, scope, webAcl.attrId)
+    utils.createCfnOutput(`${id}-webAclArn`, scope, webAcl.attrArn)
 
     return webAcl
   }