@gradientedge/cdk-utils 8.121.0 → 8.123.0

package/README.md

@@ -25,7 +25,7 @@
 
 ## Introduction
 
-Toolkit for working with the [AWS CDK][aws-cdk].
+Toolkit for working with CDK Constructs ([AWS CDK][aws-cdk] & [CDK for Terraform][cdktf]).
 
 For more details, see the full [API documentation](https://gradientedge.github.io/cdk-utils/).
 
@@ -65,6 +65,7 @@ pnpm add @gradientedge/cdk-utils
 [builds]: https://img.shields.io/github/actions/workflow/status/gradientedge/cdk-utils/ci.yml?branch=main
 [builds-url]: https://github.com/gradientedge/cdk-utils/actions
 [cdk-badge]: https://img.shields.io/github/package-json/dependency-version/gradientedge/cdk-utils/aws-cdk-lib
+[cdktf]: https://developer.hashicorp.com/terraform/cdktf
 [cdk-url]: https://aws.amazon.com/cdk/
 [checks]: https://img.shields.io/github/checks-status/gradientedge/cdk-utils/main
 [cmd]: https://img.shields.io/badge/command--line-4D4D4D?logo=windows-terminal&style=for-the-badge

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

@@ -81,4 +81,3 @@ export declare class CommonConstruct extends Construct {
      */
     isProductionStage: () => boolean;
 }
-export declare const applyMixins: (derivedCtor: any, constructors: any[]) => void;

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

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyMixins = exports.CommonConstruct = void 0;
+exports.CommonConstruct = void 0;
 const constructs_1 = require("constructs");
+const common_1 = require("../../common");
 const services_1 = require("../services");
 const utils_1 = require("../utils");
 /**
@@ -105,29 +106,21 @@ 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 = () => (0, utils_1.isDevStage)(this.props.stage);
+    isDevelopmentStage = () => (0, common_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 = () => (0, utils_1.isTestStage)(this.props.stage);
+    isTestStage = () => (0, common_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 = () => (0, utils_1.isUatStage)(this.props.stage);
+    isUatStage = () => (0, common_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 = () => (0, utils_1.isPrdStage)(this.props.stage);
+    isProductionStage = () => (0, common_1.isPrdStage)(this.props.stage);
 }
 exports.CommonConstruct = CommonConstruct;
-const applyMixins = (derivedCtor, constructors) => {
-    constructors.forEach(baseCtor => {
-        Object.getOwnPropertyNames(baseCtor.prototype).forEach(name => {
-            Object.defineProperty(derivedCtor.prototype, name, Object.getOwnPropertyDescriptor(baseCtor.prototype, name) || Object.create(null));
-        });
-    });
-};
-exports.applyMixins = applyMixins;

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

@@ -7,9 +7,10 @@ exports.CommonStack = void 0;
 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 app_root_path_1 = __importDefault(require("app-root-path"));
+const lodash_1 = __importDefault(require("lodash"));
+const common_1 = require("../../common");
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
  * @example
@@ -69,7 +70,7 @@ class CommonStack extends aws_cdk_lib_1.Stack {
                 console.debug(`No additional contexts provided. Using default context properties from cdk.json`);
             return;
         }
-        extraContexts.forEach((context) => {
+        lodash_1.default.forEach(extraContexts, (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_1.default.existsSync(extraContextPath))
@@ -81,7 +82,7 @@ class CommonStack extends aws_cdk_lib_1.Stack {
             /* parse as JSON properties */
             const extraContextProps = JSON.parse(extraContextPropsBuffer.toString('utf-8'));
             /* set each of the property into the cdk node context */
-            Object.keys(extraContextProps).forEach((propKey) => {
+            lodash_1.default.keys(extraContextProps).forEach((propKey) => {
                 this.node.setContext(propKey, extraContextProps[propKey]);
             });
         });
@@ -96,7 +97,7 @@ class CommonStack extends aws_cdk_lib_1.Stack {
         const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv';
         const stageContextFilePath = `${app_root_path_1.default.path}/${stageContextPath}/${stage}.json`;
         const debug = this.node.tryGetContext('debug');
-        if ((0, utils_1.isDevStage)(stage)) {
+        if ((0, common_1.isDevStage)(stage)) {
             if (debug)
                 console.debug(`Development stage. Using default stage context properties`);
         }
@@ -115,13 +116,10 @@ class CommonStack extends aws_cdk_lib_1.Stack {
         /* parse as JSON properties */
         const stageContextProps = JSON.parse(stageContextPropsBuffer.toString('utf-8'));
         /* set each of the property into the cdk node context */
-        Object.keys(stageContextProps).forEach((propKey) => {
+        lodash_1.default.keys(stageContextProps).forEach((propKey) => {
             /* handle object, array properties */
             if (typeof stageContextProps[propKey] === 'object' && !Array.isArray(stageContextProps[propKey])) {
-                this.node.setContext(propKey, {
-                    ...this.node.tryGetContext(propKey),
-                    ...stageContextProps[propKey],
-                });
+                this.node.setContext(propKey, lodash_1.default.merge(this.node.tryGetContext(propKey), stageContextProps[propKey]));
             }
             else {
                 /* handle all other primitive properties */

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

@@ -1,17 +1,11 @@
 import { StackProps } from 'aws-cdk-lib';
 import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda';
 import { RetentionDays } from 'aws-cdk-lib/aws-logs';
+import { BaseProps } from '../../common';
 /**
  */
-export interface CommonStackProps extends StackProps {
-    name: string;
+export interface CommonStackProps extends BaseProps, StackProps {
     region: string;
-    stage: string;
-    domainName: string;
-    subDomain?: string;
-    extraContexts?: string[];
-    stageContextPath?: string;
-    skipStageForARecords: boolean;
     logRetention?: RetentionDays;
     defaultReservedLambdaConcurrentExecutions?: number;
     defaultTracing?: Tracing;

package/dist/src/lib/aws/construct/api-to-any-target/main.js

@@ -85,33 +85,31 @@ class ApiToAnyTarget extends common_1.CommonConstruct {
             return;
         }
         this.apiToAnyTargetRestApi.api = new aws_apigateway_1.RestApi(this, `${this.id}-rest-api`, {
-            ...{
-                cloudWatchRole: this.props.api.restApi?.cloudWatchRole ?? true,
-                defaultCorsPreflightOptions: {
-                    allowHeaders: aws_apigateway_1.Cors.DEFAULT_HEADERS,
-                    allowMethods: aws_apigateway_1.Cors.ALL_METHODS,
-                    allowOrigins: aws_apigateway_1.Cors.ALL_ORIGINS,
-                },
-                defaultIntegration: this.apiToAnyTargetRestApi.integration,
-                defaultMethodOptions: {
-                    methodResponses: [this.apiToAnyTargetRestApi.methodResponse, this.apiToAnyTargetRestApi.methodErrorResponse],
-                },
-                deploy: this.props.api.restApi?.deploy ?? true,
-                deployOptions: {
-                    accessLogDestination: new aws_apigateway_1.LogGroupLogDestination(this.apiToAnyTargetRestApi.accessLogGroup),
-                    accessLogFormat: aws_apigateway_1.AccessLogFormat.jsonWithStandardFields(),
-                    dataTraceEnabled: this.props.api.restApi?.deployOptions?.dataTraceEnabled,
-                    description: `${this.id} - ${this.props.stage} stage`,
-                    loggingLevel: aws_apigateway_1.MethodLoggingLevel.INFO,
-                    metricsEnabled: true,
-                    stageName: this.props.stage,
-                    tracingEnabled: this.props.api.restApi?.deployOptions?.tracingEnabled,
-                },
-                endpointConfiguration: {
-                    types: [this.isProductionStage() ? aws_apigateway_1.EndpointType.EDGE : aws_apigateway_1.EndpointType.REGIONAL],
-                },
-                restApiName: `${this.id}-rest-api-${this.props.stage}`,
+            cloudWatchRole: this.props.api.restApi?.cloudWatchRole ?? true,
+            defaultCorsPreflightOptions: {
+                allowHeaders: aws_apigateway_1.Cors.DEFAULT_HEADERS,
+                allowMethods: aws_apigateway_1.Cors.ALL_METHODS,
+                allowOrigins: aws_apigateway_1.Cors.ALL_ORIGINS,
             },
+            defaultIntegration: this.apiToAnyTargetRestApi.integration,
+            defaultMethodOptions: {
+                methodResponses: [this.apiToAnyTargetRestApi.methodResponse, this.apiToAnyTargetRestApi.methodErrorResponse],
+            },
+            deploy: this.props.api.restApi?.deploy ?? true,
+            deployOptions: {
+                accessLogDestination: new aws_apigateway_1.LogGroupLogDestination(this.apiToAnyTargetRestApi.accessLogGroup),
+                accessLogFormat: aws_apigateway_1.AccessLogFormat.jsonWithStandardFields(),
+                dataTraceEnabled: this.props.api.restApi?.deployOptions?.dataTraceEnabled,
+                description: `${this.id} - ${this.props.stage} stage`,
+                loggingLevel: aws_apigateway_1.MethodLoggingLevel.INFO,
+                metricsEnabled: true,
+                stageName: this.props.stage,
+                tracingEnabled: this.props.api.restApi?.deployOptions?.tracingEnabled,
+            },
+            endpointConfiguration: {
+                types: [this.isProductionStage() ? aws_apigateway_1.EndpointType.EDGE : aws_apigateway_1.EndpointType.REGIONAL],
+            },
+            restApiName: `${this.id}-rest-api-${this.props.stage}`,
             ...this.props.api.restApi,
         });
         this.addCfnOutput(`${this.id}-restApiId`, this.apiToAnyTargetRestApi.api.restApiId);

package/dist/src/lib/aws/construct/api-to-eventbridge-target/main.js

@@ -133,12 +133,10 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         if (this.props.api.useExisting)
             return;
         this.props.event.rule = {
-            ...{
-                eventPattern: {
-                    source: ['api-to-eventbridge-target'],
-                },
-                ruleName: `${this.id}-api-to-eventbridge-target`,
+            eventPattern: {
+                source: ['api-to-eventbridge-target'],
             },
+            ruleName: `${this.id}-api-to-eventbridge-target`,
             ...this.props.event.rule,
         };
         this.apiEvent.rule = this.eventManager.createRule(`${this.id}-api-to-eventbridge-target-rule`, this, this.props.event.rule, this.apiEvent.eventBus, [new aws_events_targets_1.CloudWatchLogGroup(this.apiEvent.logGroup)]);
@@ -199,12 +197,10 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         if (!this.props.api.withResource)
             return;
         this.apiToEventBridgeTargetRestApi.integrationResponse = this.props.api.integrationResponse ?? {
-            ...{
-                responseTemplates: {
-                    'application/json': JSON.stringify({ message: 'Payload Submitted' }),
-                },
-                statusCode: '200',
+            responseTemplates: {
+                'application/json': JSON.stringify({ message: 'Payload Submitted' }),
             },
+            statusCode: '200',
         };
     }
     /**
@@ -214,21 +210,19 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         if (!this.props.api.withResource)
             return;
         this.apiToEventBridgeTargetRestApi.integrationErrorResponse = {
-            ...{
-                responseParameters: {
-                    'method.response.header.Access-Control-Allow-Credentials': "'true'",
-                    'method.response.header.Access-Control-Allow-Origin': "'*'",
-                    'method.response.header.Content-Type': "'application/json'",
-                },
-                responseTemplates: {
-                    'application/json': JSON.stringify({
-                        message: "$util.escapeJavaScript($input.path('$.errorMessage'))",
-                        state: 'error',
-                    }),
-                },
-                selectionPattern: '^\\[Error\\].*',
-                statusCode: '400',
+            responseParameters: {
+                'method.response.header.Access-Control-Allow-Credentials': "'true'",
+                'method.response.header.Access-Control-Allow-Origin': "'*'",
+                'method.response.header.Content-Type': "'application/json'",
             },
+            responseTemplates: {
+                'application/json': JSON.stringify({
+                    message: "$util.escapeJavaScript($input.path('$.errorMessage'))",
+                    state: 'error',
+                }),
+            },
+            selectionPattern: '^\\[Error\\].*',
+            statusCode: '400',
             ...this.props.api.integrationErrorResponse,
         };
     }
@@ -241,16 +235,14 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         this.apiToEventBridgeTargetRestApi.integration = new aws_apigateway_1.Integration({
             integrationHttpMethod: 'POST',
             options: {
-                ...{
-                    credentialsRole: this.apiToEventBridgeTargetRestApi.role,
-                    integrationResponses: [
-                        this.apiToEventBridgeTargetRestApi.integrationResponse,
-                        this.apiToEventBridgeTargetRestApi.integrationErrorResponse,
-                    ],
-                    passthroughBehavior: aws_apigateway_1.PassthroughBehavior.NEVER,
-                    requestParameters: this.apiToEventBridgeTargetRestApi.integrationRequestParameters,
-                    requestTemplates: this.apiToEventBridgeTargetRestApi.integrationRequestTemplates,
-                },
+                credentialsRole: this.apiToEventBridgeTargetRestApi.role,
+                integrationResponses: [
+                    this.apiToEventBridgeTargetRestApi.integrationResponse,
+                    this.apiToEventBridgeTargetRestApi.integrationErrorResponse,
+                ],
+                passthroughBehavior: aws_apigateway_1.PassthroughBehavior.NEVER,
+                requestParameters: this.apiToEventBridgeTargetRestApi.integrationRequestParameters,
+                requestTemplates: this.apiToEventBridgeTargetRestApi.integrationRequestTemplates,
                 ...this.props.api.integrationOptions,
             },
             type: aws_apigateway_1.IntegrationType.AWS,
@@ -264,17 +256,15 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         if (!this.props.api.withResource)
             return;
         this.apiToEventBridgeTargetRestApi.methodResponse = {
-            ...{
-                responseModels: {
-                    'application/json': this.apiToEventBridgeTargetRestApi.responseModel,
-                },
-                responseParameters: {
-                    'method.response.header.Access-Control-Allow-Credentials': true,
-                    'method.response.header.Access-Control-Allow-Origin': true,
-                    'method.response.header.Content-Type': true,
-                },
-                statusCode: '200',
+            responseModels: {
+                'application/json': this.apiToEventBridgeTargetRestApi.responseModel,
+            },
+            responseParameters: {
+                'method.response.header.Access-Control-Allow-Credentials': true,
+                'method.response.header.Access-Control-Allow-Origin': true,
+                'method.response.header.Content-Type': true,
             },
+            statusCode: '200',
             ...this.props.api.methodResponse,
         };
     }
@@ -285,17 +275,15 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         if (!this.props.api.withResource)
             return;
         this.apiToEventBridgeTargetRestApi.methodErrorResponse = {
-            ...{
-                responseModels: {
-                    'application/json': this.apiToEventBridgeTargetRestApi.errorResponseModel,
-                },
-                responseParameters: {
-                    'method.response.header.Access-Control-Allow-Credentials': true,
-                    'method.response.header.Access-Control-Allow-Origin': true,
-                    'method.response.header.Content-Type': true,
-                },
-                statusCode: '400',
+            responseModels: {
+                'application/json': this.apiToEventBridgeTargetRestApi.errorResponseModel,
             },
+            responseParameters: {
+                'method.response.header.Access-Control-Allow-Credentials': true,
+                'method.response.header.Access-Control-Allow-Origin': true,
+                'method.response.header.Content-Type': true,
+            },
+            statusCode: '400',
             ...this.props.api.methodErrorResponse,
         };
     }
@@ -314,36 +302,34 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
             return;
         }
         this.apiToEventBridgeTargetRestApi.api = new aws_apigateway_1.RestApi(this, `${this.id}-rest-api`, {
-            ...{
-                cloudWatchRole: this.props.api.restApi?.cloudWatchRole ?? true,
-                defaultCorsPreflightOptions: {
-                    allowHeaders: aws_apigateway_1.Cors.DEFAULT_HEADERS,
-                    allowMethods: ['POST'],
-                    allowOrigins: aws_apigateway_1.Cors.ALL_ORIGINS,
-                },
-                defaultIntegration: this.apiToEventBridgeTargetRestApi.integration,
-                defaultMethodOptions: {
-                    methodResponses: [
-                        this.apiToEventBridgeTargetRestApi.methodResponse,
-                        this.apiToEventBridgeTargetRestApi.methodErrorResponse,
-                    ],
-                },
-                deploy: this.props.api.restApi?.deploy ?? true,
-                deployOptions: {
-                    accessLogDestination: new aws_apigateway_1.LogGroupLogDestination(this.apiToEventBridgeTargetRestApi.accessLogGroup),
-                    accessLogFormat: aws_apigateway_1.AccessLogFormat.jsonWithStandardFields(),
-                    dataTraceEnabled: this.props.api.restApi?.deployOptions?.dataTraceEnabled,
-                    description: `${this.id} - ${this.props.stage} stage`,
-                    loggingLevel: aws_apigateway_1.MethodLoggingLevel.INFO,
-                    metricsEnabled: true,
-                    stageName: this.props.stage,
-                    tracingEnabled: this.props.api.restApi?.deployOptions?.tracingEnabled,
-                },
-                endpointConfiguration: {
-                    types: [aws_apigateway_1.EndpointType.REGIONAL],
-                },
-                restApiName: `${this.id}-rest-api-${this.props.stage}`,
+            cloudWatchRole: this.props.api.restApi?.cloudWatchRole ?? true,
+            defaultCorsPreflightOptions: {
+                allowHeaders: aws_apigateway_1.Cors.DEFAULT_HEADERS,
+                allowMethods: ['POST'],
+                allowOrigins: aws_apigateway_1.Cors.ALL_ORIGINS,
+            },
+            defaultIntegration: this.apiToEventBridgeTargetRestApi.integration,
+            defaultMethodOptions: {
+                methodResponses: [
+                    this.apiToEventBridgeTargetRestApi.methodResponse,
+                    this.apiToEventBridgeTargetRestApi.methodErrorResponse,
+                ],
+            },
+            deploy: this.props.api.restApi?.deploy ?? true,
+            deployOptions: {
+                accessLogDestination: new aws_apigateway_1.LogGroupLogDestination(this.apiToEventBridgeTargetRestApi.accessLogGroup),
+                accessLogFormat: aws_apigateway_1.AccessLogFormat.jsonWithStandardFields(),
+                dataTraceEnabled: this.props.api.restApi?.deployOptions?.dataTraceEnabled,
+                description: `${this.id} - ${this.props.stage} stage`,
+                loggingLevel: aws_apigateway_1.MethodLoggingLevel.INFO,
+                metricsEnabled: true,
+                stageName: this.props.stage,
+                tracingEnabled: this.props.api.restApi?.deployOptions?.tracingEnabled,
+            },
+            endpointConfiguration: {
+                types: [aws_apigateway_1.EndpointType.REGIONAL],
             },
+            restApiName: `${this.id}-rest-api-${this.props.stage}`,
             ...this.props.api.restApi,
         });
         this.addCfnOutput(`${this.id}-restApiId`, this.apiToEventBridgeTargetRestApi.api.restApiId);
@@ -357,15 +343,13 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
             return;
         this.apiToEventBridgeTargetRestApi.responseModel = new aws_apigateway_1.Model(this, `${this.id}-response-model`, {
             restApi: this.apiToEventBridgeTargetRestApi.api,
-            ...{
-                contentType: 'application/json',
-                modelName: 'ResponseModel',
-                schema: {
-                    properties: { message: { type: aws_apigateway_1.JsonSchemaType.STRING } },
-                    schema: aws_apigateway_1.JsonSchemaVersion.DRAFT4,
-                    title: 'pollResponse',
-                    type: aws_apigateway_1.JsonSchemaType.OBJECT,
-                },
+            contentType: 'application/json',
+            modelName: 'ResponseModel',
+            schema: {
+                properties: { message: { type: aws_apigateway_1.JsonSchemaType.STRING } },
+                schema: aws_apigateway_1.JsonSchemaVersion.DRAFT4,
+                title: 'pollResponse',
+                type: aws_apigateway_1.JsonSchemaType.OBJECT,
             },
             ...this.props.api.responseModel,
         });
@@ -378,18 +362,16 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
             return;
         this.apiToEventBridgeTargetRestApi.errorResponseModel = new aws_apigateway_1.Model(this, `${this.id}-error-response-model`, {
             restApi: this.apiToEventBridgeTargetRestApi.api,
-            ...{
-                contentType: 'application/json',
-                modelName: 'ErrorResponseModel',
-                schema: {
-                    properties: {
-                        message: { type: aws_apigateway_1.JsonSchemaType.STRING },
-                        state: { type: aws_apigateway_1.JsonSchemaType.STRING },
-                    },
-                    schema: aws_apigateway_1.JsonSchemaVersion.DRAFT4,
-                    title: 'errorResponse',
-                    type: aws_apigateway_1.JsonSchemaType.OBJECT,
+            contentType: 'application/json',
+            modelName: 'ErrorResponseModel',
+            schema: {
+                properties: {
+                    message: { type: aws_apigateway_1.JsonSchemaType.STRING },
+                    state: { type: aws_apigateway_1.JsonSchemaType.STRING },
                 },
+                schema: aws_apigateway_1.JsonSchemaVersion.DRAFT4,
+                title: 'errorResponse',
+                type: aws_apigateway_1.JsonSchemaType.OBJECT,
             },
             ...this.props.api.errorResponseModel,
         });