@gradientedge/cdk-utils 4.3.0 → 4.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "4.3.0",
+  "version": "4.4.1",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -25,17 +25,17 @@
   },
   "homepage": "https://github.com/gradientedge/cdk-utils#readme",
   "scripts": {
-    "build": "rimraf dist/ && npx tsc",
+    "build": "rimraf dist/ && npx tsc && npx lerna run build",
     "ci": "yarn install --frozen-lockfile && yarn build && yarn validate && yarn docs",
     "cz": "npx cz",
-    "typedocs": "rimraf api-docs/ && npx typedoc",
     "docs": "rimraf api-docs && npx jsdoc --pedantic -c jsdoc.json .",
+    "lint": "yarn prettify && eslint **/*.ts --max-warnings=0",
     "fix": "yarn prettify && eslint --fix **/*.ts",
+    "postinstall": "npx lerna run init",
     "prettier": "npx prettier --check \"**/*.{ts,json,md}\"",
     "prettify": "npx prettier --write \"**/*.{ts,json,md}\"",
-    "test": "npx jest",
-    "validate": "yarn prettier && yarn test",
-    "watch": "npx tsc --watch"
+    "test": "rimraf coverage && npx jest --ci --runInBand",
+    "validate": "yarn prettier && yarn test"
   },
   "husky": {
     "hooks": {
@@ -45,11 +45,11 @@
   "dependencies": {
     "@aws-cdk/aws-lambda-python-alpha": "2.10.0-alpha.0",
     "@types/lodash": "^4.14.178",
-    "@types/node": "^17.0.13",
+    "@types/node": "^17.0.14",
     "app-root-path": "^3.0.0",
     "aws-cdk-lib": "^2.10.0",
     "aws-sdk": "^2.1066.0",
-    "constructs": "^10.0.48",
+    "constructs": "^10.0.52",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
     "nconf": "^0.11.3",
@@ -59,14 +59,14 @@
   "devDependencies": {
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@types/jest": "^27.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.10.1",
-    "@typescript-eslint/parser": "^5.10.1",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
     "aws-cdk": "*",
     "babel-eslint": "^10.1.0",
     "better-docs": "^2.7.1",
     "codecov": "^3.8.3",
     "commitizen": "^4.2.4",
-    "dotenv": "^14.3.2",
+    "dotenv": "^15.0.0",
     "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.4",
@@ -77,14 +77,13 @@
     "jsdoc": "^3.6.10",
     "jsdoc-babel": "^0.5.0",
     "jsdoc-mermaid": "^1.0.0",
+    "lerna": "^4.0.0",
     "prettier": "^2.5.1",
     "prettier-plugin-organize-imports": "^2.3.4",
     "rimraf": "^3.0.2",
     "semantic-release": "^19.0.2",
     "ts-jest": "^27.1.3",
     "ts-node": "^10.4.0",
-    "typedoc": "^0.22.11",
-    "typedoc-plugin-mermaid": "^1.6.0",
     "typescript": "4.5.5"
   },
   "optionalDependencies": {

package/src/lib/common/{commonConstruct.ts → construct.ts}

@@ -7,7 +7,7 @@ import * as utils from '../utils'
 /**
  * @stability stable
  * @category Constructs
- * @summary Common construct to use as a base for all higher level constructs.
+ * @classdesc Common construct to use as a base for all higher level constructs.
  *
  * @example
  * import { CommonConstruct } from '@gradientedge/cdk-utils';
@@ -18,11 +18,6 @@ import * as utils from '../utils'
  *     this.props = props;
  *   };
  * };
- *
- * @mermaid
- *   graph LR;
- *     A[CommonConstruct]-.->|extends|B(Construct);
- *     B(Construct)-->|implements|C(IConstruct);
  */
 export class CommonConstruct extends Construct {
   props: types.CommonStackProps
@@ -50,12 +45,6 @@ export class CommonConstruct extends Construct {
   wafManager: aws.WafManager
   fullyQualifiedDomainName: string
 
-  /**
-   * @summary Constructor to initialise the CommonConstruct
-   * @param {Construct} parent
-   * @param {string} id scoped id of the resource
-   * @param {CommonStackProps} props
-   */
   constructor(parent: Construct, id: string, props: types.CommonStackProps) {
     super(parent, id)
     this.props = props
@@ -80,7 +69,6 @@ export class CommonConstruct extends Construct {
     this.snsManager = new aws.SnsManager()
     this.ssMManager = new aws.SsmManager()
     this.vpcManager = new aws.VpcManager()
-    this.vpcManager = new aws.VpcManager()
     this.wafManager = new aws.WafManager()
 
     this.determineFullyQualifiedDomain()

package/src/lib/common/index.ts

@@ -1,2 +1,2 @@
-export * from './commonConstruct'
-export * from './commonStack'
+export * from './construct'
+export * from './stack'

package/src/lib/common/{commonStack.ts → stack.ts}

@@ -1,7 +1,7 @@
 import * as cdk from 'aws-cdk-lib'
 import { CommonStackProps } from '../types'
 import { isDevStage } from '../utils'
-import { CommonConstruct } from './commonConstruct'
+import { CommonConstruct } from './construct'
 
 const appRoot = require('app-root-path')
 const fs = require('fs')
@@ -9,7 +9,7 @@ const fs = require('fs')
 /**
  * @stability stable
  * @category Stacks
- * @summary Common stack to use as a base for all higher level constructs.
+ * @classdesc Common stack to use as a base for all higher level constructs.
  *
  * @example
  * import { CommonStack } from '@gradientedge/cdk-utils'
@@ -20,21 +20,11 @@ const fs = require('fs')
  *     // provision resources
  *   }
  * }
- *
- * @mermaid
- *   graph LR;
- *     A[CommonStack]-.->|extends|B(cdk.Stack);
- *     B(cdk.Stack)-->|implements|C(cdk.ITaggable);
  */
 export class CommonStack extends cdk.Stack {
   construct: CommonConstruct
   props: CommonStackProps
-  /**
-   * @summary Constructor to initialise the CommonStack
-   * @param {cdk.App} parent
-   * @param {string} name
-   * @param {cdk.StackProps} props
-   */
+
   constructor(parent: cdk.App, name: string, props: cdk.StackProps) {
     super(parent, name, props)
 

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

@@ -0,0 +1,16 @@
+import * as events from 'aws-cdk-lib/aws-events'
+import * as logs from 'aws-cdk-lib/aws-logs'
+import * as types from '../../types/aws'
+
+/**
+ * @stability stable
+ * @category Constructs
+ * @classdesc Provides a construct to contain event resources for ApiToEventBridgeTarget
+ */
+export class ApiDestinationEvent implements types.ApiDestinationEventType {
+  eventBus: events.IEventBus
+  logGroupFailure: logs.LogGroup
+  logGroupSuccess: logs.LogGroup
+  ruleFailure: events.Rule
+  ruleSuccess: events.Rule
+}

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

@@ -0,0 +1,19 @@
+import * as iam from 'aws-cdk-lib/aws-iam'
+import * as lambda from 'aws-cdk-lib/aws-lambda'
+import * as destinations from 'aws-cdk-lib/aws-lambda-destinations'
+import * as types from '../../types/aws'
+
+/**
+ * @stability stable
+ * @category Constructs
+ * @classdesc Provides a construct to contain lambda resources for ApiToEventBridgeTarget
+ */
+export class ApiDestinedLambda implements types.ApiDestinedLambdaType {
+  destinationFailure: destinations.EventBridgeDestination
+  destinationSuccess: destinations.EventBridgeDestination
+  environment: types.ApiDestinedLambdaEnvironment
+  function: lambda.Function
+  layers: lambda.LayerVersion[]
+  policy: iam.PolicyDocument
+  role: iam.Role
+}

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

@@ -0,0 +1,31 @@
+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 route53 from 'aws-cdk-lib/aws-route53'
+import * as sns from 'aws-cdk-lib/aws-sns'
+import * as types from '../../types/aws'
+
+/**
+ * @stability stable
+ * @category Constructs
+ * @classdesc Provides a construct to contain api resources for ApiToEventBridgeTarget
+ */
+export class ApiDestinedRestApi implements types.ApiDestinedRestApiType {
+  api: apig.RestApi
+  certificate: acm.ICertificate
+  domain: apig.DomainName
+  errorResponseModel: apig.Model
+  hostedZone: route53.IHostedZone
+  integration: apig.Integration
+  integrationErrorResponse: apig.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
+  topicRole: iam.Role
+}

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

@@ -0,0 +1,4 @@
+export * from './api-destination-event'
+export * from './api-destined-lambda'
+export * from './api-destined-rest-api'
+export * from './main'