@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/.eslintrc.json

@@ -0,0 +1,40 @@
+{
+  "env": {
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "plugin:jsdoc/recommended-typescript"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint", "jsdoc"],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/no-empty-interface": "off",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/no-unused-vars": "off",
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-returns": "off",
+    "jsdoc/check-tag-names": "off",
+    "jsdoc/require-returns-description": "off",
+    "no-empty": "off",
+    "sort-keys": [
+      "error",
+      "asc",
+      {
+        "caseSensitive": true,
+        "natural": false,
+        "minKeys": 2
+      }
+    ]
+  }
+}

package/app/api-destined-function/src/lib/lambda.ts

@@ -4,19 +4,19 @@ export const processEvent = (event: any) => {
   if (!event) throw new Error('Invalid Event')
 
   return {
-    statusCode: 200,
-    id: uuidv4(),
-    message: 'Webhook call successful',
     body: {
       event: event,
     },
-    origin: event.headers?.origin,
-    source: 'custom:api-destined-lambda',
-    sourceId: process.env.SOURCE_ID,
     httpMethod: event.httpMethod,
+    id: uuidv4(),
+    message: 'Webhook call successful',
+    origin: event.headers?.origin,
     path: event.path,
     referer: event.headers?.referer,
     resource: event.resource,
+    source: 'custom:api-destined-lambda',
+    sourceId: process.env.SOURCE_ID,
+    statusCode: 200,
     success: true,
   }
 }

package/dist/app/api-destined-function/src/lib/lambda.d.ts

@@ -1,16 +1,16 @@
 export declare const processEvent: (event: any) => {
-    statusCode: number;
-    id: string;
-    message: string;
     body: {
         event: any;
     };
-    origin: any;
-    source: string;
-    sourceId: string | undefined;
     httpMethod: any;
+    id: string;
+    message: string;
+    origin: any;
     path: any;
     referer: any;
     resource: any;
+    source: string;
+    sourceId: string | undefined;
+    statusCode: number;
     success: boolean;
 };

package/dist/app/api-destined-function/src/lib/lambda.js

@@ -6,19 +6,19 @@ const processEvent = (event) => {
     if (!event)
         throw new Error('Invalid Event');
     return {
-        statusCode: 200,
-        id: (0, uuid_1.v4)(),
-        message: 'Webhook call successful',
         body: {
             event: event,
         },
-        origin: event.headers?.origin,
-        source: 'custom:api-destined-lambda',
-        sourceId: process.env.SOURCE_ID,
         httpMethod: event.httpMethod,
+        id: (0, uuid_1.v4)(),
+        message: 'Webhook call successful',
+        origin: event.headers?.origin,
         path: event.path,
         referer: event.headers?.referer,
         resource: event.resource,
+        source: 'custom:api-destined-lambda',
+        sourceId: process.env.SOURCE_ID,
+        statusCode: 200,
         success: true,
     };
 };

package/dist/lib/lambda.d.ts

@@ -1,17 +1,17 @@
 export declare const processEvent: (event: any) => {
-    statusCode: number;
-    id: string;
-    message: string;
     body: {
         event: any;
     };
-    origin: any;
-    source: string;
-    sourceId: string | undefined;
     httpMethod: any;
+    id: string;
+    message: string;
+    origin: any;
     path: any;
     referer: any;
     resource: any;
+    source: string;
+    sourceId: string | undefined;
+    statusCode: number;
     success: boolean;
 };
 //# sourceMappingURL=lambda.d.ts.map

package/dist/lib/lambda.js

@@ -6,19 +6,19 @@ const processEvent = (event) => {
     if (!event)
         throw new Error('Invalid Event');
     return {
-        statusCode: 200,
-        id: (0, uuid_1.v4)(),
-        message: 'Webhook call successful',
         body: {
             event: event,
         },
-        origin: event.headers?.origin,
-        source: 'custom:api-destined-lambda',
-        sourceId: process.env.SOURCE_ID,
         httpMethod: event.httpMethod,
+        id: (0, uuid_1.v4)(),
+        message: 'Webhook call successful',
+        origin: event.headers?.origin,
         path: event.path,
         referer: event.headers?.referer,
         resource: event.resource,
+        source: 'custom:api-destined-lambda',
+        sourceId: process.env.SOURCE_ID,
+        statusCode: 200,
         success: true,
     };
 };

package/dist/lib/lambda.js.map

@@ -1 +1 @@
-{"version":3,"file":"lambda.js","sourceRoot":"","sources":["../../app/api-destined-function/src/lib/lambda.ts"],"names":[],"mappings":";;;AAAA,+BAAmC;AAE5B,MAAM,YAAY,GAAG,CAAC,KAAU,EAAE,EAAE;IACzC,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;IAE5C,OAAO;QACL,UAAU,EAAE,GAAG;QACf,EAAE,EAAE,IAAA,SAAM,GAAE;QACZ,OAAO,EAAE,yBAAyB;QAClC,IAAI,EAAE;YACJ,KAAK,EAAE,KAAK;SACb;QACD,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM;QAC7B,MAAM,EAAE,4BAA4B;QACpC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS;QAC/B,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO;QAC/B,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,OAAO,EAAE,IAAI;KACd,CAAA;AACH,CAAC,CAAA;AAnBY,QAAA,YAAY,gBAmBxB;AAED,OAAO,CAAC,OAAO,GAAG,KAAK,EAAE,KAAU,EAAE,OAAY,EAAE,QAAa,EAAE,EAAE;IAClE,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5C,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAChD,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5D,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAAA;AAC5C,CAAC,CAAA"}
+{"version":3,"file":"lambda.js","sourceRoot":"","sources":["../../app/api-destined-function/src/lib/lambda.ts"],"names":[],"mappings":";;;AAAA,+BAAmC;AAE5B,MAAM,YAAY,GAAG,CAAC,KAAU,EAAE,EAAE;IACzC,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;IAE5C,OAAO;QACL,IAAI,EAAE;YACJ,KAAK,EAAE,KAAK;SACb;QACD,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,EAAE,EAAE,IAAA,SAAM,GAAE;QACZ,OAAO,EAAE,yBAAyB;QAClC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM;QAC7B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO;QAC/B,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,MAAM,EAAE,4BAA4B;QACpC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS;QAC/B,UAAU,EAAE,GAAG;QACf,OAAO,EAAE,IAAI;KACd,CAAA;AACH,CAAC,CAAA;AAnBY,QAAA,YAAY,gBAmBxB;AAED,OAAO,CAAC,OAAO,GAAG,KAAK,EAAE,KAAU,EAAE,OAAY,EAAE,QAAa,EAAE,EAAE;IAClE,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5C,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAChD,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5D,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAA,oBAAY,EAAC,KAAK,CAAC,CAAC,CAAA;AAC5C,CAAC,CAAA"}

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

@@ -3,11 +3,8 @@ import { Construct } from 'constructs';
 import * as aws from '../services/aws';
 import { CommonStackProps } from './types';
 /**
- * @stability stable
- * @category cdk-utils.common-construct
  * @subcategory Construct
  * @classdesc Common construct to use as a base for all higher level constructs.
- *
  * @example
  * import { CommonConstruct } from '@gradientedge/cdk-utils';
  *
@@ -53,10 +50,10 @@ export declare class CommonConstruct extends Construct {
     constructor(parent: Construct, id: string, props: CommonStackProps);
     /**
      * @summary Helper method to add CloudFormation outputs from the construct
-     * @param {string} id scoped id of the resource
-     * @param {string} value the value of the exported output
-     * @param {string?} description optional description for the output
-     * @param {boolean} overrideId Flag which indicates whether to override the default logical id of the output
+     * @param id scoped id of the resource
+     * @param value the value of the exported output
+     * @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;
     /**

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

@@ -28,11 +28,8 @@ const constructs_1 = require("constructs");
 const aws = __importStar(require("../services/aws"));
 const utils = __importStar(require("../utils"));
 /**
- * @stability stable
- * @category cdk-utils.common-construct
  * @subcategory Construct
  * @classdesc Common construct to use as a base for all higher level constructs.
- *
  * @example
  * import { CommonConstruct } from '@gradientedge/cdk-utils';
  *
@@ -111,10 +108,10 @@ class CommonConstruct extends constructs_1.Construct {
     }
     /**
      * @summary Helper method to add CloudFormation outputs from the construct
-     * @param {string} id scoped id of the resource
-     * @param {string} value the value of the exported output
-     * @param {string?} description optional description for the output
-     * @param {boolean} overrideId Flag which indicates whether to override the default logical id of the output
+     * @param id scoped id of the resource
+     * @param value the value of the exported output
+     * @param description optional description for the output
+     * @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);

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

@@ -2,11 +2,7 @@ import * as cdk from 'aws-cdk-lib';
 import { CommonStackProps } from './types';
 import { CommonConstruct } from './construct';
 /**
- * @stability stable
- * @category cdk-utils.common-stack
- * @subcategory Construct
  * @classdesc Common stack to use as a base for all higher level constructs.
- *
  * @example
  * import { CommonStack } from '@gradientedge/cdk-utils'
  *
@@ -24,21 +20,21 @@ export declare class CommonStack extends cdk.Stack {
     constructor(parent: cdk.App, name: string, props: cdk.StackProps);
     /**
      * @summary Method to determine the core CDK construct properties injected via context cdk.json
-     * @param {cdk.StackProps} props The stack properties
-     * @return The stack properties
+     * @param props The stack properties
+     * @returns The stack properties
      */
     protected determineConstructProps(props: cdk.StackProps): {
-        stackName: string | undefined;
-        name: string;
-        region: any;
-        stage: any;
         domainName: any;
-        subDomain: any;
+        excludeDomainNameForBuckets: any;
         extraContexts: any;
-        skipStageForARecords: any;
         logRetention: any;
-        excludeDomainNameForBuckets: any;
+        name: string;
         nodejsRuntime: any;
+        region: any;
+        skipStageForARecords: any;
+        stackName: string | undefined;
+        stage: any;
+        subDomain: any;
     };
     /**
      * @summary Method to determine extra cdk contexts apart from the main cdk.json

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

@@ -31,11 +31,7 @@ const construct_1 = require("./construct");
 const appRoot = require('app-root-path');
 const fs = require('fs');
 /**
- * @stability stable
- * @category cdk-utils.common-stack
- * @subcategory Construct
  * @classdesc Common stack to use as a base for all higher level constructs.
- *
  * @example
  * import { CommonStack } from '@gradientedge/cdk-utils'
  *
@@ -62,22 +58,22 @@ class CommonStack extends cdk.Stack {
     }
     /**
      * @summary Method to determine the core CDK construct properties injected via context cdk.json
-     * @param {cdk.StackProps} props The stack properties
-     * @return The stack properties
+     * @param props The stack properties
+     * @returns The stack properties
      */
     determineConstructProps(props) {
         return {
-            stackName: props.stackName,
-            name: props.stackName || 'cdk-utils',
-            region: this.node.tryGetContext('region'),
-            stage: this.node.tryGetContext('stage'),
             domainName: this.node.tryGetContext('domainName'),
-            subDomain: this.node.tryGetContext('subDomain'),
+            excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
             extraContexts: this.node.tryGetContext('extraContexts'),
-            skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
             logRetention: this.node.tryGetContext('logRetention'),
-            excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
+            name: props.stackName || 'cdk-utils',
             nodejsRuntime: this.node.tryGetContext('nodejsRuntime') ?? CommonStack.NODEJS_RUNTIME,
+            region: this.node.tryGetContext('region'),
+            skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
+            stackName: props.stackName,
+            stage: this.node.tryGetContext('stage'),
+            subDomain: this.node.tryGetContext('subDomain'),
         };
     }
     /**

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

@@ -2,8 +2,6 @@ import * as cdk from 'aws-cdk-lib';
 import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda';
 import { RetentionDays } from 'aws-cdk-lib/aws-logs';
 /**
- * @category cdk-utils.common-stack
- * @subcategory Properties
  */
 export interface CommonStackProps extends cdk.StackProps {
     name: string;

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

@@ -6,9 +6,6 @@ import * as route53 from 'aws-cdk-lib/aws-route53';
 import * as sns from 'aws-cdk-lib/aws-sns';
 import { ApiToEventBridgeTargetRestApiType } from './types';
 /**
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory member
  * @classdesc Provides a construct to contain api resources for ApiToEventBridgeTargetWithSns
  */
 export declare class ApiToEventbridgeTargetRestApi implements ApiToEventBridgeTargetRestApiType {

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

@@ -2,9 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiToEventbridgeTargetRestApi = void 0;
 /**
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory member
  * @classdesc Provides a construct to contain api resources for ApiToEventBridgeTargetWithSns
  */
 class ApiToEventbridgeTargetRestApi {

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

@@ -2,9 +2,6 @@ import * as events from 'aws-cdk-lib/aws-events';
 import * as logs from 'aws-cdk-lib/aws-logs';
 import { ApiToEventBridgeTargetEventType } from './types';
 /**
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory member
  * @classdesc Provides a construct to contain event resources for ApiToEventBridgeTargetWithSns
  */
 export declare class ApiToEventbridgeTargetEvent implements ApiToEventBridgeTargetEventType {

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

@@ -2,9 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiToEventbridgeTargetEvent = void 0;
 /**
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory member
  * @classdesc Provides a construct to contain event resources for ApiToEventBridgeTargetWithSns
  */
 class ApiToEventbridgeTargetEvent {

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

@@ -3,13 +3,9 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common';
 import { ApiToEventBridgeTargetEventType, ApiToEventBridgeTargetProps, ApiToEventBridgeTargetRestApiType } from './types';
 /**
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy API Gateway invocations to EventBridge
  *
  * <b>Architecture</b><br/> ![Architecture](./ApiToEventBridgeTarget.jpg)
- *
  * @example
  * import { ApiToEventBridgeTarget, ApiToEventBridgeTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -22,7 +18,6 @@ import { ApiToEventBridgeTargetEventType, ApiToEventBridgeTargetProps, ApiToEven
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare class ApiToEventBridgeTarget extends CommonConstruct {
     props: ApiToEventBridgeTargetProps;
@@ -36,114 +31,92 @@ export declare class ApiToEventBridgeTarget extends CommonConstruct {
     /**
      * @summary Method to resolve secrets from SecretsManager
      * - To be implemented in the overriding method in the implementation class
-     * @protected
      */
     protected resolveSecrets(): void;
     /**
      * @summary Method to resolve a hosted zone based on domain attributes
-     * @protected
      */
     protected resolveHostedZone(): void;
     /**
      * @summary Method to resolve a certificate based on attributes
-     * @protected
      */
     protected resolveCertificate(): void;
     /**
      * @summary Method to create or use an existing eventbus for api payload deliveries
-     * @protected
      */
     protected createApiToEventBridgeTargetEventBus(): void;
     /**
      * @summary Method to create a log group for successful api payload deliveries
-     * @protected
      */
     protected createApiToEventBridgeTargetLogGroup(): void;
     /**
      * Method to create EventBridge rule with lambda target for success
-     * @protected
      */
     protected createApiToEventBridgeTargetRule(): void;
     protected createApiToEventBridgeTargetPolicy(): void;
     /**
      * @summary Method to create a role for api integration
-     * @protected
      */
     protected createApiToEventBridgeTargetRole(): void;
     /**
      * @summary Method to create api integration request parameters
-     * @protected
      */
     protected createApiToEventBridgeTargetIntegrationRequestParameters(): void;
     /**
      * @summary Method to create api integration request templates
-     * @protected
      */
     protected createApiToEventBridgeTargetIntegrationRequestTemplates(): void;
     /**
      * @summary Method to create api integration response
-     * @protected
      */
     protected createApiToEventBridgeTargetIntegrationResponse(): void;
     /**
      * @summary Method to create api integration error response
-     * @protected
      */
     protected createApiToEventBridgeTargetIntegrationErrorResponse(): void;
     /**
      * @summary Method to create api integration
-     * @protected
      */
     protected createApiToEventBridgeTargetIntegration(): void;
     /**
      * @summary Method to create api integration method response
-     * @protected
      */
     protected createApiToEventBridgeTargetMethodResponse(): void;
     /**
      * @summary Method to create api integration method error response
-     * @protected
      */
     protected createApiToEventBridgeTargetMethodErrorResponse(): void;
     protected createApiToEventBridgeTargetRestApiLogGroup(): void;
     /**
      * @summary Method to create rest restApi for Api
-     * @protected
      */
     protected createApiToEventBridgeTargetRestApi(): void;
     /**
      * @summary Method to create api integration response model
-     * @protected
      */
     protected createApiToEventBridgeTargetResponseModel(): void;
     /**
      * @summary Method to create api integration error response model
-     * @protected
      */
     protected createApiToEventBridgeTargetErrorResponseModel(): void;
     /**
      * @summary Method to create api integration resource
-     * @protected
      */
     protected createApiToEventBridgeTargetResource(): void;
     /**
      * @summary Method to create api integration resource method
-     * @protected
      */
     protected createApiToEventBridgeTargetResourceMethod(): void;
     /**
      * @summary Method to create custom restApi domain for Api
-     * @protected
      */
     protected createApiDomain(): void;
     /**
      * @summary Method to create base path mappings for Api
-     * @protected
      */
     protected createApiBasePathMapping(): void;
     /**
      * @summary Method to create route53 records for Api
-     * @protected
      */
     protected createApiRouteAssets(): void;
 }