@gradientedge/cdk-utils 8.118.0 → 8.119.0

package/app/api-destined-function/package.json

@@ -16,7 +16,7 @@
     "test": "npx jest --ci --runInBand --passWithNoTests"
   },
   "dependencies": {
-    "@types/uuid": "^9.0.2",
+    "@types/uuid": "^9.0.3",
     "uuid": "^9.0.0"
   },
   "devDependencies": {

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

@@ -1,6 +1,6 @@
-import * as cdk from 'aws-cdk-lib';
+import { CfnOutput } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
-import * as aws from '../services/aws';
+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 { CommonStackProps } from './types';
 /**
  * @subcategory Construct
@@ -17,35 +17,35 @@ import { CommonStackProps } from './types';
  */
 export declare 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);
     /**
@@ -55,7 +55,7 @@ export declare 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?: boolean): cdk.CfnOutput;
+    protected addCfnOutput(id: string, value: string, description?: string, overrideId?: boolean): CfnOutput;
     /**
      * @summary Determine the fully qualified domain name based on domainName & subDomain
      */

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

@@ -1,32 +1,9 @@
 "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;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applyMixins = exports.CommonConstruct = void 0;
 const constructs_1 = require("constructs");
-const aws = __importStar(require("../services/aws"));
-const utils = __importStar(require("../utils"));
+const services_1 = require("../services");
+const utils_1 = require("../utils");
 /**
  * @subcategory Construct
  * @classdesc Common construct to use as a base for all higher level constructs.
@@ -75,35 +52,35 @@ class CommonConstruct extends constructs_1.Construct {
     constructor(parent, id, props) {
         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 services_1.AcmManager();
+        this.apiManager = new services_1.ApiManager();
+        this.appConfigManager = new services_1.AppConfigManager();
+        this.codeBuildManager = new services_1.CodeBuildManager();
+        this.cloudFrontManager = new services_1.CloudFrontManager();
+        this.cloudTrailManager = new services_1.CloudTrailManager();
+        this.cloudWatchManager = new services_1.CloudWatchManager();
+        this.dynamodbManager = new services_1.DynamodbManager();
+        this.ecrManager = new services_1.EcrManager();
+        this.ecsManager = new services_1.EcsManager();
+        this.efsManager = new services_1.EfsManager();
+        this.eksManager = new services_1.EksManager();
+        this.elasticacheManager = new services_1.ElastiCacheManager();
+        this.eventManager = new services_1.EventManager();
+        this.eventTargetManager = new services_1.EventTargetManager();
+        this.evidentlyManager = new services_1.EvidentlyManager();
+        this.iamManager = new services_1.IamManager();
+        this.kmsManager = new services_1.KmsManager();
+        this.lambdaManager = new services_1.LambdaManager();
+        this.logManager = new services_1.LogManager();
+        this.route53Manager = new services_1.Route53Manager();
+        this.s3Manager = new services_1.S3Manager();
+        this.secretsManager = new services_1.SecretsManager();
+        this.sfnManager = new services_1.SfnManager();
+        this.snsManager = new services_1.SnsManager();
+        this.sqsManager = new services_1.SqsManager();
+        this.ssmManager = new services_1.SsmManager();
+        this.vpcManager = new services_1.VpcManager();
+        this.wafManager = new services_1.WafManager();
         this.determineFullyQualifiedDomain();
     }
     /**
@@ -114,7 +91,7 @@ class CommonConstruct extends constructs_1.Construct {
      * @param overrideId Flag which indicates whether to override the default logical id of the output
      */
     addCfnOutput(id, value, description, overrideId = true) {
-        return utils.createCfnOutput(id, this, value, description, overrideId);
+        return (0, utils_1.createCfnOutput)(id, this, value, description, overrideId);
     }
     /**
      * @summary Determine the fully qualified domain name based on domainName & subDomain
@@ -128,22 +105,22 @@ class CommonConstruct extends constructs_1.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
      */
-    isDevelopmentStage = () => utils.isDevStage(this.props.stage);
+    isDevelopmentStage = () => (0, utils_1.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 = () => utils.isTestStage(this.props.stage);
+    isTestStage = () => (0, utils_1.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 = () => utils.isUatStage(this.props.stage);
+    isUatStage = () => (0, utils_1.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 = () => utils.isPrdStage(this.props.stage);
+    isProductionStage = () => (0, utils_1.isPrdStage)(this.props.stage);
 }
 exports.CommonConstruct = CommonConstruct;
 const applyMixins = (derivedCtor, constructors) => {

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

@@ -1,29 +1,30 @@
-import * as cdk from 'aws-cdk-lib';
-import { CommonStackProps } from './types';
+import { App, Stack, StackProps } from 'aws-cdk-lib';
+import { Runtime } from 'aws-cdk-lib/aws-lambda';
 import { CommonConstruct } from './construct';
+import { CommonStackProps } from './types';
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
  * @example
  * 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 declare class CommonStack extends cdk.Stack {
-    static NODEJS_RUNTIME: cdk.aws_lambda.Runtime;
+export declare class CommonStack extends Stack {
+    static NODEJS_RUNTIME: Runtime;
     construct: CommonConstruct;
     props: CommonStackProps;
-    constructor(parent: cdk.App, name: string, props: cdk.StackProps);
+    constructor(parent: App, name: string, props: StackProps);
     /**
      * @summary Method to determine the core CDK construct properties injected via context cdk.json
      * @param props The stack properties
      * @returns The stack properties
      */
-    protected determineConstructProps(props: cdk.StackProps): {
+    protected determineConstructProps(props: StackProps): {
         domainName: any;
         excludeDomainNameForBuckets: any;
         extraContexts: any;

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

@@ -1,49 +1,29 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __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.CommonStack = void 0;
-const cdk = __importStar(require("aws-cdk-lib"));
-const lambda = __importStar(require("aws-cdk-lib/aws-lambda"));
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const aws_lambda_1 = require("aws-cdk-lib/aws-lambda");
+const fs_1 = __importDefault(require("fs"));
 const utils_1 = require("../utils");
 const construct_1 = require("./construct");
-const appRoot = require('app-root-path');
-const fs = require('fs');
+const app_root_path_1 = __importDefault(require("app-root-path"));
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
  * @example
  * 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
  *   }
  * }
  */
-class CommonStack extends cdk.Stack {
-    static NODEJS_RUNTIME = lambda.Runtime.NODEJS_18_X;
+class CommonStack extends aws_cdk_lib_1.Stack {
+    static NODEJS_RUNTIME = aws_lambda_1.Runtime.NODEJS_18_X;
     construct;
     props;
     constructor(parent, name, props) {
@@ -90,16 +70,16 @@ class CommonStack extends cdk.Stack {
             return;
         }
         extraContexts.forEach((context) => {
-            const extraContextPath = `${appRoot.path}/${context}`;
+            const extraContextPath = `${app_root_path_1.default.path}/${context}`;
             /* scenario where extra context is configured in cdk.json but absent in file system */
-            if (!fs.existsSync(extraContextPath))
+            if (!fs_1.default.existsSync(extraContextPath))
                 throw `Extra context properties unavailable in path:${extraContextPath}`;
             /* read the extra properties */
-            const extraContextPropsBuffer = fs.readFileSync(extraContextPath);
+            const extraContextPropsBuffer = fs_1.default.readFileSync(extraContextPath);
             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) => {
                 this.node.setContext(propKey, extraContextProps[propKey]);
@@ -114,14 +94,14 @@ class CommonStack extends cdk.Stack {
     determineStageContexts() {
         const stage = this.node.tryGetContext('stage');
         const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv';
-        const stageContextFilePath = `${appRoot.path}/${stageContextPath}/${stage}.json`;
+        const stageContextFilePath = `${app_root_path_1.default.path}/${stageContextPath}/${stage}.json`;
         const debug = this.node.tryGetContext('debug');
         if ((0, utils_1.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 (!fs_1.default.existsSync(stageContextFilePath)) {
             if (debug)
                 console.debug(`Stage specific context properties unavailable in path:${stageContextFilePath}`);
             if (debug)
@@ -129,11 +109,11 @@ class CommonStack extends cdk.Stack {
             return;
         }
         /* read the extra properties */
-        const stageContextPropsBuffer = fs.readFileSync(stageContextFilePath);
+        const stageContextPropsBuffer = fs_1.default.readFileSync(stageContextFilePath);
         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) => {
             /* handle object, array properties */

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

@@ -1,9 +1,9 @@
-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/dist/src/lib/construct/api-to-eventbridge-target/api.d.ts

@@ -1,34 +1,34 @@
-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 declare 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/dist/src/lib/construct/api-to-eventbridge-target/event.d.ts

@@ -1,15 +1,15 @@
-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 declare 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;
 }

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

@@ -1,4 +1,4 @@
-import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager';
+import { ISecret } from 'aws-cdk-lib/aws-secretsmanager';
 import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common';
 import { ApiToEventBridgeTargetEventType, ApiToEventBridgeTargetProps, ApiToEventBridgeTargetRestApiType } from './types';
@@ -22,7 +22,7 @@ import { ApiToEventBridgeTargetEventType, ApiToEventBridgeTargetProps, ApiToEven
 export declare class ApiToEventBridgeTarget extends CommonConstruct {
     props: ApiToEventBridgeTargetProps;
     id: string;
-    applicationSecrets: secretsmanager.ISecret[];
+    applicationSecrets: ISecret[];
     apiEvent: ApiToEventBridgeTargetEventType;
     apiToEventBridgeTargetRestApi: ApiToEventBridgeTargetRestApiType;
     apiResource: string;
@@ -42,7 +42,7 @@ export declare class ApiToEventBridgeTarget extends CommonConstruct {
      */
     protected resolveCertificate(): void;
     /**
-     * @summary Method to create or use an existing eventbus for api payload deliveries
+     * @summary Method to create or use an existing event bus for api payload deliveries
      */
     protected createApiToEventBridgeTargetEventBus(): void;
     /**