@gradientedge/cdk-utils 8.118.0 → 8.119.0

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

@@ -1,32 +1,12 @@
 "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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.determineCredentials = exports.createCfnOutput = void 0;
-const cdk = __importStar(require("aws-cdk-lib"));
-const _ = __importStar(require("lodash"));
 const credential_providers_1 = require("@aws-sdk/credential-providers");
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const lodash_1 = __importDefault(require("lodash"));
 /**
  * @summary Helper method to add CloudFormation outputs from the construct
  * @param id scoped id of the resource
@@ -37,8 +17,8 @@ const credential_providers_1 = require("@aws-sdk/credential-providers");
  * @returns The CloudFormation output
  */
 function createCfnOutput(id, scope, value, description, overrideId = true) {
-    const camelName = _.camelCase(id);
-    const output = new cdk.CfnOutput(scope, id, {
+    const camelName = lodash_1.default.camelCase(id);
+    const output = new aws_cdk_lib_1.CfnOutput(scope, id, {
         description,
         exportName: `${scope.props.stackName}-${camelName}`,
         value: value ?? '',
@@ -49,6 +29,9 @@ function createCfnOutput(id, scope, value, description, overrideId = true) {
     return output;
 }
 exports.createCfnOutput = createCfnOutput;
+/**
+ *
+ */
 function determineCredentials() {
     if (process.env.AWS_PROFILE)
         return (0, credential_providers_1.fromIni)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.118.0",
+  "version": "8.119.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -46,15 +46,15 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.398.0",
-    "@aws-sdk/credential-providers": "^3.398.0",
+    "@aws-sdk/client-secrets-manager": "^3.405.0",
+    "@aws-sdk/credential-providers": "^3.405.0",
     "@aws-sdk/types": "^3.398.0",
     "@types/lodash": "^4.14.197",
-    "@types/node": "^20.5.7",
-    "@types/uuid": "^9.0.2",
+    "@types/node": "^20.5.9",
+    "@types/uuid": "^9.0.3",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.93.0",
-    "constructs": "^10.2.69",
+    "aws-cdk-lib": "^2.94.0",
+    "constructs": "^10.2.70",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "nconf": "^0.12.0",
@@ -63,22 +63,22 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.11",
-    "@babel/eslint-parser": "^7.22.11",
+    "@babel/core": "^7.22.15",
+    "@babel/eslint-parser": "^7.22.15",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@types/jest": "^29.5.4",
-    "@typescript-eslint/eslint-plugin": "^6.5.0",
-    "@typescript-eslint/parser": "^6.5.0",
-    "aws-cdk": "^2.93.0",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "aws-cdk": "^2.94.0",
     "better-docs": "^2.7.2",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.0",
-    "docdash": "^2.0.1",
+    "docdash": "^2.0.2",
     "dotenv": "^16.3.1",
     "eslint": "^8.48.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jsdoc": "^46.5.0",
+    "eslint-plugin-jsdoc": "^46.5.1",
     "husky": "^8.0.3",
     "jest": "^29.6.4",
     "jest-extended": "^4.0.1",
@@ -88,7 +88,7 @@
     "jsdoc-mermaid": "^1.0.0",
     "jsdoc-plugin-typescript": "^2.2.1",
     "jsdoc-to-markdown": "^8.0.0",
-    "prettier": "^3.0.2",
+    "prettier": "^3.0.3",
     "prettier-plugin-organize-imports": "^3.2.3",
     "rimraf": "^5.0.1",
     "semantic-release": "^21.1.1",

package/src/lib/common/construct.ts

@@ -1,7 +1,37 @@
-import * as cdk from 'aws-cdk-lib'
+import { CfnOutput } from 'aws-cdk-lib'
 import { Construct } from 'constructs'
-import * as aws from '../services/aws'
-import * as utils from '../utils'
+import {
+  AcmManager,
+  ApiManager,
+  AppConfigManager,
+  CloudFrontManager,
+  CloudTrailManager,
+  CloudWatchManager,
+  CodeBuildManager,
+  DynamodbManager,
+  EcrManager,
+  EcsManager,
+  EfsManager,
+  EksManager,
+  ElastiCacheManager,
+  EventManager,
+  EventTargetManager,
+  EvidentlyManager,
+  IamManager,
+  KmsManager,
+  LambdaManager,
+  LogManager,
+  Route53Manager,
+  S3Manager,
+  SecretsManager,
+  SfnManager,
+  SnsManager,
+  SqsManager,
+  SsmManager,
+  VpcManager,
+  WafManager,
+} from '../services'
+import { createCfnOutput, isDevStage, isPrdStage, isTestStage, isUatStage } from '../utils'
 import { CommonStackProps } from './types'
 
 /**
@@ -19,70 +49,70 @@ import { CommonStackProps } from './types'
  */
 export class CommonConstruct extends Construct {
   props: CommonStackProps
-  acmManager: aws.AcmManager
-  apiManager: aws.ApiManager
-  appConfigManager: aws.AppConfigManager
-  codeBuildManager: aws.CodeBuildManager
-  cloudFrontManager: aws.CloudFrontManager
-  cloudTrailManager: aws.CloudTrailManager
-  cloudWatchManager: aws.CloudWatchManager
-  dynamodbManager: aws.DynamodbManager
-  ecrManager: aws.EcrManager
-  ecsManager: aws.EcsManager
-  efsManager: aws.EfsManager
-  eksManager: aws.EksManager
-  elasticacheManager: aws.ElastiCacheManager
-  eventManager: aws.EventManager
-  eventTargetManager: aws.EventTargetManager
-  evidentlyManager: aws.EvidentlyManager
-  iamManager: aws.IamManager
-  kmsManager: aws.KmsManager
-  lambdaManager: aws.LambdaManager
-  logManager: aws.LogManager
-  route53Manager: aws.Route53Manager
-  s3Manager: aws.S3Manager
-  secretsManager: aws.SecretsManager
-  sfnManager: aws.SfnManager
-  snsManager: aws.SnsManager
-  sqsManager: aws.SqsManager
-  ssmManager: aws.SsmManager
-  vpcManager: aws.VpcManager
-  wafManager: aws.WafManager
+  acmManager: AcmManager
+  apiManager: ApiManager
+  appConfigManager: AppConfigManager
+  codeBuildManager: CodeBuildManager
+  cloudFrontManager: CloudFrontManager
+  cloudTrailManager: CloudTrailManager
+  cloudWatchManager: CloudWatchManager
+  dynamodbManager: DynamodbManager
+  ecrManager: EcrManager
+  ecsManager: EcsManager
+  efsManager: EfsManager
+  eksManager: EksManager
+  elasticacheManager: ElastiCacheManager
+  eventManager: EventManager
+  eventTargetManager: EventTargetManager
+  evidentlyManager: EvidentlyManager
+  iamManager: IamManager
+  kmsManager: KmsManager
+  lambdaManager: LambdaManager
+  logManager: LogManager
+  route53Manager: Route53Manager
+  s3Manager: S3Manager
+  secretsManager: SecretsManager
+  sfnManager: SfnManager
+  snsManager: SnsManager
+  sqsManager: SqsManager
+  ssmManager: SsmManager
+  vpcManager: VpcManager
+  wafManager: WafManager
 
   fullyQualifiedDomainName: string
 
   constructor(parent: Construct, id: string, props: CommonStackProps) {
     super(parent, id)
     this.props = props
-    this.acmManager = new aws.AcmManager()
-    this.apiManager = new aws.ApiManager()
-    this.appConfigManager = new aws.AppConfigManager()
-    this.codeBuildManager = new aws.CodeBuildManager()
-    this.cloudFrontManager = new aws.CloudFrontManager()
-    this.cloudTrailManager = new aws.CloudTrailManager()
-    this.cloudWatchManager = new aws.CloudWatchManager()
-    this.dynamodbManager = new aws.DynamodbManager()
-    this.ecrManager = new aws.EcrManager()
-    this.ecsManager = new aws.EcsManager()
-    this.efsManager = new aws.EfsManager()
-    this.eksManager = new aws.EksManager()
-    this.elasticacheManager = new aws.ElastiCacheManager()
-    this.eventManager = new aws.EventManager()
-    this.eventTargetManager = new aws.EventTargetManager()
-    this.evidentlyManager = new aws.EvidentlyManager()
-    this.iamManager = new aws.IamManager()
-    this.kmsManager = new aws.KmsManager()
-    this.lambdaManager = new aws.LambdaManager()
-    this.logManager = new aws.LogManager()
-    this.route53Manager = new aws.Route53Manager()
-    this.s3Manager = new aws.S3Manager()
-    this.secretsManager = new aws.SecretsManager()
-    this.sfnManager = new aws.SfnManager()
-    this.snsManager = new aws.SnsManager()
-    this.sqsManager = new aws.SqsManager()
-    this.ssmManager = new aws.SsmManager()
-    this.vpcManager = new aws.VpcManager()
-    this.wafManager = new aws.WafManager()
+    this.acmManager = new AcmManager()
+    this.apiManager = new ApiManager()
+    this.appConfigManager = new AppConfigManager()
+    this.codeBuildManager = new CodeBuildManager()
+    this.cloudFrontManager = new CloudFrontManager()
+    this.cloudTrailManager = new CloudTrailManager()
+    this.cloudWatchManager = new CloudWatchManager()
+    this.dynamodbManager = new DynamodbManager()
+    this.ecrManager = new EcrManager()
+    this.ecsManager = new EcsManager()
+    this.efsManager = new EfsManager()
+    this.eksManager = new EksManager()
+    this.elasticacheManager = new ElastiCacheManager()
+    this.eventManager = new EventManager()
+    this.eventTargetManager = new EventTargetManager()
+    this.evidentlyManager = new EvidentlyManager()
+    this.iamManager = new IamManager()
+    this.kmsManager = new KmsManager()
+    this.lambdaManager = new LambdaManager()
+    this.logManager = new LogManager()
+    this.route53Manager = new Route53Manager()
+    this.s3Manager = new S3Manager()
+    this.secretsManager = new SecretsManager()
+    this.sfnManager = new SfnManager()
+    this.snsManager = new SnsManager()
+    this.sqsManager = new SqsManager()
+    this.ssmManager = new SsmManager()
+    this.vpcManager = new VpcManager()
+    this.wafManager = new WafManager()
 
     this.determineFullyQualifiedDomain()
   }
@@ -94,8 +124,8 @@ export class CommonConstruct extends Construct {
    * @param description optional description for the output
    * @param overrideId Flag which indicates whether to override the default logical id of the output
    */
-  protected addCfnOutput(id: string, value: string, description?: string, overrideId = true): cdk.CfnOutput {
-    return utils.createCfnOutput(id, this, value, description, overrideId)
+  protected addCfnOutput(id: string, value: string, description?: string, overrideId = true): CfnOutput {
+    return createCfnOutput(id, this, value, description, overrideId)
   }
 
   /**
@@ -111,25 +141,25 @@ export class CommonConstruct extends Construct {
    * @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 = () => utils.isDevStage(this.props.stage)
+  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 = () => utils.isTestStage(this.props.stage)
+  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 = () => utils.isUatStage(this.props.stage)
+  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 = () => utils.isPrdStage(this.props.stage)
+  public isProductionStage = () => isPrdStage(this.props.stage)
 }
 
 export const applyMixins = (derivedCtor: any, constructors: any[]) => {

package/src/lib/common/stack.ts

@@ -1,11 +1,11 @@
-import * as cdk from 'aws-cdk-lib'
-import * as lambda from 'aws-cdk-lib/aws-lambda'
-import { CommonStackProps } from './types'
+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'
 
-const appRoot = require('app-root-path')
-const fs = require('fs')
+import appRoot from 'app-root-path'
 
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
@@ -13,19 +13,19 @@ const fs = require('fs')
  * import { CommonStack } from '@gradientedge/cdk-utils'
  *
  * class CustomStack extends CommonStack {
- *   constructor(parent: cdk.App, name: string, props: cdk.StackProps) {
+ *   constructor(parent: App, name: string, props: StackProps) {
  *     super(parent, name, props)
  *     // provision resources
  *   }
  * }
  */
-export class CommonStack extends cdk.Stack {
-  public static NODEJS_RUNTIME = lambda.Runtime.NODEJS_18_X
+export class CommonStack extends Stack {
+  public static NODEJS_RUNTIME = Runtime.NODEJS_18_X
 
   construct: CommonConstruct
   props: CommonStackProps
 
-  constructor(parent: cdk.App, name: string, props: cdk.StackProps) {
+  constructor(parent: App, name: string, props: StackProps) {
     super(parent, name, props)
 
     /* determine extra cdk contexts */
@@ -45,7 +45,7 @@ export class CommonStack extends cdk.Stack {
    * @param props The stack properties
    * @returns The stack properties
    */
-  protected determineConstructProps(props: cdk.StackProps) {
+  protected determineConstructProps(props: StackProps) {
     return {
       domainName: this.node.tryGetContext('domainName'),
       excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
@@ -86,7 +86,7 @@ export class CommonStack extends cdk.Stack {
       if (debug) console.debug(`Adding additional contexts provided in ${extraContextPath}`)
 
       /* parse as JSON properties */
-      const extraContextProps = JSON.parse(extraContextPropsBuffer)
+      const extraContextProps = JSON.parse(extraContextPropsBuffer.toString('utf-8'))
 
       /* set each of the property into the cdk node context */
       Object.keys(extraContextProps).forEach((propKey: any) => {
@@ -122,7 +122,7 @@ export class CommonStack extends cdk.Stack {
     if (debug) console.debug(`Adding additional stage contexts provided in ${stageContextFilePath}`)
 
     /* parse as JSON properties */
-    const stageContextProps = JSON.parse(stageContextPropsBuffer)
+    const stageContextProps = JSON.parse(stageContextPropsBuffer.toString('utf-8'))
 
     /* set each of the property into the cdk node context */
     Object.keys(stageContextProps).forEach((propKey: any) => {

package/src/lib/common/types.ts

@@ -1,10 +1,10 @@
-import * as cdk from 'aws-cdk-lib'
+import { StackProps } from 'aws-cdk-lib'
 import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda'
 import { RetentionDays } from 'aws-cdk-lib/aws-logs'
 
 /**
  */
-export interface CommonStackProps extends cdk.StackProps {
+export interface CommonStackProps extends StackProps {
   name: string
   region: string
   stage: string

package/src/lib/construct/api-to-eventbridge-target/api.ts

@@ -1,31 +1,40 @@
-import * as apig from 'aws-cdk-lib/aws-apigateway'
-import * as acm from 'aws-cdk-lib/aws-certificatemanager'
-import * as iam from 'aws-cdk-lib/aws-iam'
-import * as logs from 'aws-cdk-lib/aws-logs'
-import * as route53 from 'aws-cdk-lib/aws-route53'
-import * as sns from 'aws-cdk-lib/aws-sns'
+import {
+  DomainName,
+  Integration,
+  IntegrationResponse,
+  Method,
+  MethodResponse,
+  Model,
+  Resource,
+  RestApi,
+} from 'aws-cdk-lib/aws-apigateway'
+import { ICertificate } from 'aws-cdk-lib/aws-certificatemanager'
+import { Role } from 'aws-cdk-lib/aws-iam'
+import { LogGroup } from 'aws-cdk-lib/aws-logs'
+import { IHostedZone } from 'aws-cdk-lib/aws-route53'
+import { Topic } from 'aws-cdk-lib/aws-sns'
 import { ApiToEventBridgeTargetRestApiType } from './types'
 
 /**
  * @classdesc Provides a construct to contain api resources for ApiToEventBridgeTargetWithSns
  */
 export class ApiToEventbridgeTargetRestApi implements ApiToEventBridgeTargetRestApiType {
-  accessLogGroup: logs.LogGroup
-  api: apig.RestApi
-  certificate: acm.ICertificate
-  domain: apig.DomainName
-  errorResponseModel: apig.Model
-  hostedZone: route53.IHostedZone
-  integration: apig.Integration
-  integrationErrorResponse: apig.IntegrationResponse
+  accessLogGroup: LogGroup
+  api: RestApi
+  certificate: ICertificate
+  domain: DomainName
+  errorResponseModel: Model
+  hostedZone: IHostedZone
+  integration: Integration
+  integrationErrorResponse: IntegrationResponse
   integrationRequestParameters: { [p: string]: string }
   integrationRequestTemplates: { [p: string]: string }
-  integrationResponse: apig.IntegrationResponse
-  method: apig.Method
-  methodErrorResponse: apig.MethodResponse
-  methodResponse: apig.MethodResponse
-  resource: apig.Resource
-  responseModel: apig.Model
-  topic: sns.Topic
-  role: iam.Role
+  integrationResponse: IntegrationResponse
+  method: Method
+  methodErrorResponse: MethodResponse
+  methodResponse: MethodResponse
+  resource: Resource
+  responseModel: Model
+  topic: Topic
+  role: Role
 }

package/src/lib/construct/api-to-eventbridge-target/event.ts

@@ -1,16 +1,16 @@
-import * as events from 'aws-cdk-lib/aws-events'
-import * as logs from 'aws-cdk-lib/aws-logs'
+import { IEventBus, Rule } from 'aws-cdk-lib/aws-events'
+import { LogGroup } from 'aws-cdk-lib/aws-logs'
 import { ApiToEventBridgeTargetEventType } from './types'
 
 /**
  * @classdesc Provides a construct to contain event resources for ApiToEventBridgeTargetWithSns
  */
 export class ApiToEventbridgeTargetEvent implements ApiToEventBridgeTargetEventType {
-  eventBus: events.IEventBus
-  logGroup: logs.LogGroup
-  logGroupFailure: logs.LogGroup
-  logGroupSuccess: logs.LogGroup
-  rule: events.Rule
-  ruleFailure: events.Rule
-  ruleSuccess: events.Rule
+  eventBus: IEventBus
+  logGroup: LogGroup
+  logGroupFailure: LogGroup
+  logGroupSuccess: LogGroup
+  rule: Rule
+  ruleFailure: Rule
+  ruleSuccess: Rule
 }