@gradientedge/cdk-utils 4.3.2 → 4.4.3

package/app/api-destined-function/node_modules/wrappy/README.md

@@ -0,0 +1,36 @@
+# wrappy
+
+Callback wrapping utility
+
+## USAGE
+
+```javascript
+var wrappy = require("wrappy")
+
+// var wrapper = wrappy(wrapperFunction)
+
+// make sure a cb is called only once
+// See also: http://npm.im/once for this specific use case
+var once = wrappy(function (cb) {
+  var called = false
+  return function () {
+    if (called) return
+    called = true
+    return cb.apply(this, arguments)
+  }
+})
+
+function printBoo () {
+  console.log('boo')
+}
+// has some rando property
+printBoo.iAmBooPrinter = true
+
+var onlyPrintOnce = once(printBoo)
+
+onlyPrintOnce() // prints 'boo'
+onlyPrintOnce() // does nothing
+
+// random property is retained!
+assert.equal(onlyPrintOnce.iAmBooPrinter, true)
+```

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

@@ -0,0 +1,29 @@
+{
+  "name": "wrappy",
+  "version": "1.0.2",
+  "description": "Callback wrapping utility",
+  "main": "wrappy.js",
+  "files": [
+    "wrappy.js"
+  ],
+  "directories": {
+    "test": "test"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "tap": "^2.3.1"
+  },
+  "scripts": {
+    "test": "tap --coverage test/*.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/npm/wrappy"
+  },
+  "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/npm/wrappy/issues"
+  },
+  "homepage": "https://github.com/npm/wrappy"
+}

package/app/api-destined-function/node_modules/wrappy/wrappy.js

@@ -0,0 +1,33 @@
+// Returns a wrapper function that returns a wrapped callback
+// The wrapper function should do some stuff, and return a
+// presumably different callback function.
+// This makes sure that own properties are retained, so that
+// decorations and such are not lost along the way.
+module.exports = wrappy
+function wrappy (fn, cb) {
+  if (fn && cb) return wrappy(fn)(cb)
+
+  if (typeof fn !== 'function')
+    throw new TypeError('need wrapper function')
+
+  Object.keys(fn).forEach(function (k) {
+    wrapper[k] = fn[k]
+  })
+
+  return wrapper
+
+  function wrapper() {
+    var args = new Array(arguments.length)
+    for (var i = 0; i < args.length; i++) {
+      args[i] = arguments[i]
+    }
+    var ret = fn.apply(this, args)
+    var cb = args[args.length-1]
+    if (typeof ret === 'function' && ret !== cb) {
+      Object.keys(cb).forEach(function (k) {
+        ret[k] = cb[k]
+      })
+    }
+    return ret
+  }
+}

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

@@ -0,0 +1,29 @@
+{
+  "name": "@gradientedge/cdk-utils-api-destined-function",
+  "version": "0.0.0-SNAPSHOT",
+  "description": "Application for API Destined Function",
+  "main": "dist/index.js",
+  "license": "UNLICENSED",
+  "engines": {
+    "node": ">=14.16.0 <15"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gradientedge/cdk-utils.git"
+  },
+  "scripts": {
+    "build": "yarn package:function && yarn copy:layers",
+    "copy:layers": "cp -R layers ../../dist/app/api-destined-function",
+    "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"
+  },
+  "dependencies": {
+    "@types/uuid": "^8.3.4",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "mkdirp": "^1.0.4",
+    "rimraf": "^3.0.2"
+  }
+}

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

@@ -0,0 +1,31 @@
+import { v4 as uuidv4 } from 'uuid'
+
+export const processEvent = (event: any) => {
+  if (!event) throw new Error('Invalid Event')
+
+  return {
+    statusCode: 200,
+    id: uuidv4(),
+    message: 'Webhook call successful',
+    body: {
+      payload: {
+        body: event.body,
+      },
+    },
+    origin: event.headers?.origin,
+    source: 'custom:api-destined-lambda',
+    sourceId: process.env.SOURCE_ID,
+    httpMethod: event.httpMethod,
+    path: event.path,
+    referer: event.headers?.referer,
+    resource: event.resource,
+    success: true,
+  }
+}
+
+exports.handler = async (event: any, context: any, callback: any) => {
+  console.log('Event:', JSON.stringify(event))
+  console.log('Context:', JSON.stringify(context))
+  console.log('Event Records:', JSON.stringify(event.Records))
+  return callback(null, processEvent(event))
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "4.3.2",
+  "version": "4.4.3",
   "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 bootstrap && yarn build",
     "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,33 +45,34 @@
   "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"
+    "ts-node": "^10.5.0"
   },
   "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",
@@ -82,13 +83,11 @@
     "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",
+    "ts-node": "^10.5.0",
     "typescript": "4.5.5"
   },
   "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/{commonConstruct.ts → construct.ts}

@@ -6,8 +6,9 @@ import * as utils from '../utils'
 
 /**
  * @stability stable
- * @category Constructs
- * @summary Common construct to use as a base for all higher level constructs.
+ * @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';
@@ -18,11 +19,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 +46,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

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,15 +1,16 @@
 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')
 
 /**
  * @stability stable
- * @category Stacks
- * @summary Common stack to use as a base for all higher level constructs.
+ * @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'
@@ -20,21 +21,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,17 @@
+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 cdk-utils.api-to-eventbridge-target
+ * @subcategory member
+ * @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,20 @@
+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 cdk-utils.api-to-eventbridge-target
+ * @subcategory member
+ * @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,32 @@
+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 cdk-utils.api-to-eventbridge-target
+ * @subcategory member
+ * @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'