@gradientedge/cdk-utils 6.16.0 → 7.0.0

package/dist/src/lib/manager/aws/sfn-manager.d.ts

@@ -1,12 +1,13 @@
 import * as cdk from 'aws-cdk-lib';
 import * as apig from 'aws-cdk-lib/aws-apigateway';
+import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
 import * as iam from 'aws-cdk-lib/aws-iam';
 import * as lambda from 'aws-cdk-lib/aws-lambda';
 import * as logs from 'aws-cdk-lib/aws-logs';
 import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
+import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
 import * as common from '../../common';
 import * as types from '../../types';
-import { SfnStateMachineProps } from '../../types';
 /**
  * @stability stable
  * @category cdk-utils.step-functions-manager
@@ -70,6 +71,17 @@ export declare class SfnManager {
      * @param {types.SfnWaitProps} props
      */
     createWaitStep(id: string, scope: common.CommonConstruct, props: types.SfnWaitProps): cdk.aws_stepfunctions.Wait;
+    /**
+     * @summary Method to create a DynamoDB get item step
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.SfnPassProps} props
+     * @param {dynamodb.ITable} table
+     * @param tableKey
+     */
+    createDynamoDbGetItemStep(id: string, scope: common.CommonConstruct, props: types.SfnDynamoGetItemProps, table: dynamodb.ITable, tableKey: {
+        [key: string]: tasks.DynamoAttributeValue;
+    }): cdk.aws_stepfunctions_tasks.DynamoGetItem;
     /**
      * @summary Method to create a lambda invoke step
      * @param {string} id scoped id of the resource
@@ -95,5 +107,5 @@ export declare class SfnManager {
      * @param {logs.ILogGroup} logGroup
      * @param {iam.IRole} role
      */
-    createStateMachine(id: string, scope: common.CommonConstruct, props: SfnStateMachineProps, definition: sfn.IChainable, logGroup: logs.ILogGroup, role?: iam.IRole): cdk.aws_stepfunctions.StateMachine;
+    createStateMachine(id: string, scope: common.CommonConstruct, props: types.SfnStateMachineProps, definition: sfn.IChainable, logGroup: logs.ILogGroup, role?: iam.IRole): cdk.aws_stepfunctions.StateMachine;
 }

package/dist/src/lib/manager/aws/sfn-manager.js

@@ -144,6 +144,28 @@ class SfnManager {
             },
         });
     }
+    /**
+     * @summary Method to create a DynamoDB get item step
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.SfnPassProps} props
+     * @param {dynamodb.ITable} table
+     * @param tableKey
+     */
+    createDynamoDbGetItemStep(id, scope, props, table, tableKey) {
+        if (!props)
+            throw 'Step props undefined';
+        return new tasks.DynamoGetItem(scope, `${props.name}`, {
+            ...props,
+            ...{
+                table: table,
+                key: tableKey,
+                consistentRead: props.consistentRead,
+                resultPath: props.resultPath,
+                comment: `DynamoDB GetItem step for ${props.name} - ${scope.props.stage} stage`,
+            },
+        });
+    }
     /**
      * @summary Method to create a lambda invoke step
      * @param {string} id scoped id of the resource

package/dist/src/lib/manager/aws/vpc-manager.js

@@ -64,7 +64,7 @@ class VpcManager {
             throw 'Vpc props undefined';
         const vpc = new ec2.Vpc(scope, `${id}`, {
             maxAzs: props.maxAzs,
-            cidr: props.cidr,
+            ipAddresses: props.ipAddresses,
         });
         utils.createCfnOutput(`${id}Id`, scope, vpc.vpcId);
         utils.createCfnOutput(`${id}PublicSubnetIds`, scope, vpc.publicSubnets.map(subnet => subnet.subnetId).toString());

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

@@ -135,6 +135,13 @@ export interface SfnFailProps extends sfn.FailProps {
 export interface SfnPassProps extends sfn.PassProps {
     name: string;
 }
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnDynamoGetItemProps extends tasks.DynamoGetItemProps {
+    name: string;
+}
 /**
  * @category cdk-utils.step-functions-manager
  * @subcategory Properties

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "6.16.0",
+  "version": "7.0.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -45,12 +45,12 @@
     }
   },
   "dependencies": {
-    "@types/lodash": "^4.14.186",
-    "@types/node": "^18.11.2",
+    "@types/lodash": "^4.14.188",
+    "@types/node": "^18.11.9",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.46.0",
-    "aws-sdk": "^2.1235.0",
-    "constructs": "^10.1.133",
+    "aws-cdk-lib": "^2.50.0",
+    "aws-sdk": "^2.1248.0",
+    "constructs": "^10.1.150",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "nconf": "^0.12.0",
@@ -59,23 +59,23 @@
   },
   "devDependencies": {
     "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@types/jest": "^29.2.0",
-    "@typescript-eslint/eslint-plugin": "^5.40.1",
-    "@typescript-eslint/parser": "^5.40.1",
+    "@types/jest": "^29.2.2",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
     "aws-cdk": "*",
     "babel-eslint": "^10.1.0",
     "better-docs": "^2.7.2",
     "codecov": "^3.8.3",
     "commitizen": "^4.2.5",
     "dotenv": "^16.0.3",
-    "eslint": "^8.25.0",
+    "eslint": "^8.26.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "husky": "^8.0.1",
-    "jest": "^29.2.1",
+    "jest": "^29.2.2",
     "jest-extended": "^3.1.0",
     "jest-junit": "^14.0.1",
-    "jsdoc": "^3.6.11",
+    "jsdoc": "^4.0.0",
     "jsdoc-babel": "^0.5.0",
     "jsdoc-mermaid": "^1.0.0",
     "lerna": "^5.6.2",
@@ -83,12 +83,13 @@
     "prettier-plugin-organize-imports": "^3.1.1",
     "rimraf": "^3.0.2",
     "semantic-release": "^19.0.5",
+    "taffydb": "^2.7.3",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "typescript": "4.8.4"
   },
   "optionalDependencies": {
-    "@babel/core": "^7.19.3",
+    "@babel/core": "^7.20.2",
     "prop-types": "^15.8.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

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

@@ -1,5 +1,6 @@
 import * as cdk from 'aws-cdk-lib'
 import * as apig from 'aws-cdk-lib/aws-apigateway'
+import * as dynamodb from 'aws-cdk-lib/aws-dynamodb'
 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as logs from 'aws-cdk-lib/aws-logs'
@@ -7,7 +8,6 @@ import * as sfn from 'aws-cdk-lib/aws-stepfunctions'
 import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks'
 import * as common from '../../common'
 import * as types from '../../types'
-import { SfnStateMachineProps } from '../../types'
 import * as utils from '../../utils'
 
 /**
@@ -127,6 +127,34 @@ export class SfnManager {
     })
   }
 
+  /**
+   * @summary Method to create a DynamoDB get item step
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.SfnPassProps} props
+   * @param {dynamodb.ITable} table
+   * @param tableKey
+   */
+  public createDynamoDbGetItemStep(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.SfnDynamoGetItemProps,
+    table: dynamodb.ITable,
+    tableKey: { [key: string]: tasks.DynamoAttributeValue }
+  ) {
+    if (!props) throw 'Step props undefined'
+    return new tasks.DynamoGetItem(scope, `${props.name}`, {
+      ...props,
+      ...{
+        table: table,
+        key: tableKey,
+        consistentRead: props.consistentRead,
+        resultPath: props.resultPath,
+        comment: `DynamoDB GetItem step for ${props.name} - ${scope.props.stage} stage`,
+      },
+    })
+  }
+
   /**
    * @summary Method to create a lambda invoke step
    * @param {string} id scoped id of the resource
@@ -186,7 +214,7 @@ export class SfnManager {
   public createStateMachine(
     id: string,
     scope: common.CommonConstruct,
-    props: SfnStateMachineProps,
+    props: types.SfnStateMachineProps,
     definition: sfn.IChainable,
     logGroup: logs.ILogGroup,
     role?: iam.IRole

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

@@ -40,7 +40,7 @@ export class VpcManager {
     if (!props) throw 'Vpc props undefined'
     const vpc = new ec2.Vpc(scope, `${id}`, {
       maxAzs: props.maxAzs,
-      cidr: props.cidr,
+      ipAddresses: props.ipAddresses,
     })
 
     utils.createCfnOutput(`${id}Id`, scope, vpc.vpcId)

package/src/lib/types/aws/index.ts

@@ -144,6 +144,14 @@ export interface SfnPassProps extends sfn.PassProps {
   name: string
 }
 
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnDynamoGetItemProps extends tasks.DynamoGetItemProps {
+  name: string
+}
+
 /**
  * @category cdk-utils.step-functions-manager
  * @subcategory Properties