@gradientedge/cdk-utils 4.4.1 → 4.4.5

package/README.md

@@ -1,10 +1,6 @@
-<div style='text-align:center'>
+[![Gradient Edge][logo]](https://gradientedge.com)
 
-<a href="https://gradientedge.com">![Gradient Edge][logo]</a>
-
-</div>
-
-# Gradient Edge AWS CDK Utils
+# Gradient Edge CDK Utils
 
 [![Release][release]][release-url]
 [![version][version]][version-url]

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

@@ -14,7 +14,6 @@
   "scripts": {
     "build": "yarn package:function && yarn copy:layers",
     "copy:layers": "cp -R layers ../../dist/app/api-destined-function",
-    "init": "yarn install",
     "package:function": "mkdirp layers/nodejs && cp -R package.json layers/nodejs && cd layers/nodejs && yarn install --production --no-lockfile",
     "start": "node dist/index",
     "test": "npx jest --ci --runInBand --passWithNoTests"

package/lerna.json

@@ -0,0 +1,6 @@
+{
+  "npmClient": "yarn",
+  "packages": ["*", "app/*"],
+  "useWorkspaces": false,
+  "version": "0.0.0"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "4.4.1",
+  "version": "4.4.5",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -31,7 +31,7 @@
     "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",
+    "postinstall": "npx lerna bootstrap && yarn build",
     "prettier": "npx prettier --check \"**/*.{ts,json,md}\"",
     "prettify": "npx prettier --write \"**/*.{ts,json,md}\"",
     "test": "rimraf coverage && npx jest --ci --runInBand",
@@ -45,49 +45,48 @@
   "dependencies": {
     "@aws-cdk/aws-lambda-python-alpha": "2.10.0-alpha.0",
     "@types/lodash": "^4.14.178",
-    "@types/node": "^17.0.14",
+    "@types/node": "^17.0.16",
     "app-root-path": "^3.0.0",
     "aws-cdk-lib": "^2.10.0",
-    "aws-sdk": "^2.1066.0",
-    "constructs": "^10.0.52",
+    "aws-sdk": "^2.1070.0",
+    "constructs": "^10.0.55",
+    "lerna": "^4.0.0",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
     "nconf": "^0.11.3",
     "pluralize": "^8.0.0",
-    "ts-node": "^10.4.0"
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.5.0",
+    "typescript": "^4.5.5"
   },
   "devDependencies": {
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@types/jest": "^27.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.10.2",
-    "@typescript-eslint/parser": "^5.10.2",
+    "@typescript-eslint/eslint-plugin": "^5.11.0",
+    "@typescript-eslint/parser": "^5.11.0",
     "aws-cdk": "*",
     "babel-eslint": "^10.1.0",
     "better-docs": "^2.7.1",
     "codecov": "^3.8.3",
     "commitizen": "^4.2.4",
-    "dotenv": "^15.0.0",
+    "dotenv": "^16.0.0",
     "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.4",
     "husky": "^7.0.4",
-    "jest": "^27.4.7",
+    "jest": "^27.5.0",
     "jest-extended": "^2.0.0",
     "jest-junit": "^13.0.0",
     "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",
-    "typescript": "4.5.5"
+    "ts-jest": "^27.1.3"
   },
   "optionalDependencies": {
-    "@babel/core": "^7.16.12",
+    "@babel/core": "^7.17.0",
     "prop-types": "^15.8.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"

package/src/lib/common/construct.ts

@@ -6,7 +6,8 @@ import * as utils from '../utils'
 
 /**
  * @stability stable
- * @category Constructs
+ * @category cdk-utils.common-construct
+ * @subcategory Construct
  * @classdesc Common construct to use as a base for all higher level constructs.
  *
  * @example

package/src/lib/common/stack.ts

@@ -8,7 +8,8 @@ const fs = require('fs')
 
 /**
  * @stability stable
- * @category Stacks
+ * @category cdk-utils.common-stack
+ * @subcategory Construct
  * @classdesc Common stack to use as a base for all higher level constructs.
  *
  * @example

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

@@ -4,7 +4,8 @@ import * as types from '../../types/aws'
 
 /**
  * @stability stable
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory member
  * @classdesc Provides a construct to contain event resources for ApiToEventBridgeTarget
  */
 export class ApiDestinationEvent implements types.ApiDestinationEventType {

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

@@ -5,7 +5,8 @@ import * as types from '../../types/aws'
 
 /**
  * @stability stable
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory member
  * @classdesc Provides a construct to contain lambda resources for ApiToEventBridgeTarget
  */
 export class ApiDestinedLambda implements types.ApiDestinedLambdaType {

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

@@ -7,7 +7,8 @@ import * as types from '../../types/aws'
 
 /**
  * @stability stable
- * @category Constructs
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory member
  * @classdesc Provides a construct to contain api resources for ApiToEventBridgeTarget
  */
 export class ApiDestinedRestApi implements types.ApiDestinedRestApiType {

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

@@ -13,7 +13,8 @@ import { ApiDestinedRestApi } from './api-destined-rest-api'
 
 /**
  * @stability stable
- * @category Constructs
+ * @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> ![Architecture](./ApiToEventBridgeTarget.jpg)

package/src/lib/construct/graphql-api-lambda/main.ts

@@ -10,7 +10,8 @@ import { GraphQlApiLambdaEnvironment, GraphQlApiLambdaProps } from '../../types'
 
 /**
  * @stability stable
- * @category Constructs
+ * @category cdk-utils.graphql-api-lambda
+ * @subcategory construct
  * @classdesc Provides a construct to create and deploy a Graphql API as Lambda
  *
  * <b>Architecture</b> ![Architecture](./GraphQLApiLambda.jpg)

package/src/lib/construct/site-with-ecs-backend/main.ts

@@ -17,7 +17,8 @@ import { SiteWithEcsBackendProps } from '../../types'
 
 /**
  * @stability stable
- * @category Constructs
+ * @category cdk-utils.site-with-ecs-backend
+ * @subcategory construct
  * @classdesc Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
  *
  * @example

package/src/lib/construct/static-site/main.ts

@@ -9,7 +9,8 @@ import { StaticSiteProps } from '../../types'
 
 /**
  * @stability stable
- * @category Constructs
+ * @category cdk-utils.static-site
+ * @subcategory construct
  * @classdesc Provides a construct to create and deploy a s3 hosted static site
  *
  * @example

package/src/lib/manager/aws/acm-manager.ts

@@ -7,7 +7,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Security, Identity & Compliance
+ * @category cdk-utils.acm-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Certificates.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/api-manager.ts

@@ -6,7 +6,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Networking & Content Delivery
+ * @category cdk-utils.api-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS API Gateway.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/app-config-manager.ts

@@ -6,7 +6,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Utils
+ * @category cdk-utils.app-config-manager
+ * @subcategory Construct
  * @returns { Map<string, string> } ArnsByRegion
  */
 export const ArnsByRegion: { [key: string]: string } = {
@@ -33,7 +34,8 @@ export const ArnsByRegion: { [key: string]: string } = {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.app-config-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS AppConfig.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/cloudfront-manager.ts

@@ -13,7 +13,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Networking & Content Delivery
+ * @category cdk-utils.cloudfront-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS CloudFront.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/cloudtrail-manager.ts

@@ -7,7 +7,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Management & Governance
+ * @category cdk-utils.cloudtrail-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS CloudTrail.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/cloudwatch-manager.ts

@@ -6,7 +6,8 @@ import * as types from '../../types'
 import * as utils from '../../utils'
 
 /**
- * @category Utils
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Construct
  */
 enum CloudWatchWidgetType {
   Text = 'Text',
@@ -18,7 +19,8 @@ enum CloudWatchWidgetType {
 
 /**
  * @stability stable
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS CloudWatch.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/codebuild-manager.ts

@@ -4,7 +4,8 @@ import * as common from '../../common'
 
 /**
  * @stability stable
- * @category Developer Tools
+ * @category cdk-utils.codebuild-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Code Build.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/dynamodb-manager.ts

@@ -5,7 +5,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Storage
+ * @category cdk-utils.dynamodb-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS DynamoDB.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/ecr-manager.ts

@@ -4,7 +4,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Containers
+ * @category cdk-utils.ecr-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic Container Registry.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/ecs-manager.ts

@@ -8,7 +8,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Containers
+ * @category cdk-utils.ecs-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic Container Service.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/eks-manager.ts

@@ -7,7 +7,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Containers
+ * @category cdk-utils.eks-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Elastic Kubernetes Service.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/event-manager.ts

@@ -8,7 +8,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Application Integration
+ * @category cdk-utils.event-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS EventBridge.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/iam-manager.ts

@@ -8,7 +8,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Security, Identity & Compliance
+ * @category cdk-utils.iam-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS IAM.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/lambda-manager.ts

@@ -11,7 +11,8 @@ import { CloudFrontManager } from './cloudfront-manager'
 
 /**
  * @stability stable
- * @category Compute
+ * @category cdk-utils.lambda-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Lambda.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/log-manager.ts

@@ -6,7 +6,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Management & Governance
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS CloudWatch.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/route53-manager.ts

@@ -8,7 +8,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Networking & Content Delivery
+ * @category cdk-utils.route53-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Route53.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/s3-manager.ts

@@ -9,7 +9,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Storage
+ * @category cdk-utils.s3-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS S3.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/secrets-manager.ts

@@ -7,7 +7,8 @@ const fs = require('fs')
 
 /**
  * @stability experimental
- * @category Security, Identity & Compliance
+ * @category cdk-utils.secrets-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Secrets Manager.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/sns-manager.ts

@@ -7,7 +7,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Application Integration
+ * @category cdk-utils.sns-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Simple Notification Service.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/ssm-manager.ts

@@ -6,7 +6,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Management & Governance
+ * @category cdk-utils.ssm-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS Systems Manager.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
@@ -81,7 +82,8 @@ export class SsmManager {
 }
 
 /**
- * @category Management & Governance
+ * @category cdk-utils.ssm-manager
+ * @subcategory Construct
  * @classdesc Provides utilities to read same/cross region SSM parameters
  */
 export class SSMParameterReader extends cr.AwsCustomResource {

package/src/lib/manager/aws/vpc-manager.ts

@@ -5,12 +5,14 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Utils
+ * @category cdk-utils.vpc-manager
+ * @subcategory Construct
  */
 const CommonVpcIdentifier = 'CommonVpc'
 
 /**
- * @category Networking & Content Delivery
+ * @category cdk-utils.vpc-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS VPC.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.

package/src/lib/manager/aws/waf-manager.ts

@@ -5,7 +5,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Security, Identity & Compliance
+ * @category cdk-utils.waf-manager
+ * @subcategory Construct
  * @classdesc Provides operations on AWS WAF.
  * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
  * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.