@sylvesterllc/aws-constructs 1.1.11 → 1.1.13

package/readme.md

@@ -1,148 +1,148 @@
-# Bishop CDK Construct Library
-
-## Bishop Constructs <a name="Constructs" id="Constructs"></a>
-
-Bishop Constructs is a construct library for creating new AWS Infrastructure in a standardize
-reusable manner. 
-
-[![Publish package to GitHub Packages](https://github.com/DavisSylvester/aws-constructs/actions/workflows/publish.yaml/badge.svg?branch=main)](https://github.com/DavisSylvester/aws-constructs/actions/workflows/publish.yaml)
-
-### Available Constructors
-
- - [Microservice](#microservice-construct)
-
-And more...
-
-## Installation
-
-1. Install the npm package:
-
-    `npm install @davissylvester/bishop-cdk-constructs --save`
-    - *ensure you have a `.npmrc` that uses the @sylvesterllc npm registry*
-
-
-
-# Microservice Construct
-The Microservice construct provides and easy way to get started with a basic Microservice.
-
-#### Infrastructure
-    - API Gateway (Rest API)
-    - Lambda 
-    - Dynamodb
-    - Lambda Authorizer 
-      - TokenAuthorizer
-
-#### Access 
-*All lambdas are created with Read/Write Access to DynamoDB tables*
-
-### Usage
-```typescript
-import { MicroService, MicroserviceProps } from '@davissylvester/bishop-cdk-constructs';
-
-new MicroService(this, 'microservice-test', microServiceProps);
-```
-
- ## MicroserviceProps
-
- ```json
- const microServiceProps: MicroserviceProps = {
-      GLOBALS: {
-          name: `sample-test-app`,
-          environments: "dev",
-          stackRuntime: Runtime.NODEJS_18_X,          
-      },
-      API: {
-          Name: `sample-test-app`,
-          Description: 'This is my new API'
-      },
-      RESOURCES: {
-          AUTHORIZER: {
-            name: `jwt-authorizer`,
-            codePath: './lambda-functions/authorizer/index.ts',
-            handler: 'handler',
-            apiPathRoot: '',
-            route: '',
-        }, 
-          LAMBDA: [
-              {
-                  name: `hello-world`,
-                  codePath: './lambda-functions/hello-world/index.ts',
-                  handler: 'main',
-                  method: 'get',
-                  apiPathRoot: 'hello-world',
-                  route: '/hello-world'
-              },
-              {
-                  name: `hellow-world2`,
-                  codePath: './lambda-functions/hello-world/index.ts',
-                  handler: 'main',
-                  method: 'get',
-                  apiPathRoot: '/hello-world/2',
-                  route: '/hello-world/2'
-              },
-              {
-                name: `hello-world3`,
-                codePath: './lambda-functions/hello-world/index.ts',
-                handler: 'main',
-                method: 'get',
-                apiPathRoot: '/hello-world/2',
-                route: '/hello-world/2/{id}',
-                secure: true
-            },
-          ],
-          DYNAMO: {
-              TABLES: [
-                  {
-                      tableName: `sample-audit-history`,
-                      primaryKey: {
-                          name: 'id',
-                          type: AttributeType.STRING,
-                      },
-                      billingMode: BillingMode.PAY_PER_REQUEST,
-                      indexes: [
-                          {
-                              indexName: 'createdTS',
-                              partitionKey: {
-                                  name: 'createdTS',
-                                  type: AttributeType.NUMBER
-                              },
-                              projectionType: ProjectionType.ALL
-                          },
-                          {
-                              indexName: 'username',
-                              partitionKey: {
-                                  name: 'username',
-                                  type: AttributeType.STRING
-                              },
-                              projectionType: ProjectionType.ALL
-                          },
-                      ]
-                  },
-              ],
-          },
-  
-      }
-  }; 
- ```
-
-
-## Best Practice
-When using this library it is a good practice to start with a new CDK project
-   
-   - `npm install -g typescript aws-cdk`
-   - `mkdir my-new-project`
-   - `cd my-new-project`
-   - `cdk init app --language typescript`
-   - `npm i @davissylvester/bishop-cdk-constructs`
-   - `mkdir lambda-functions` (*holds all your lambda code*)
-
-# [Demo Project](https://github.com/davissylvester/bishop-cdk-constructs-demo.git)
-
-- Clone the repository
-  - `git clone https://github.com/davissylvester/bishop-cdk-constructs-demo.git`
-  - `npm i`
-  - `cdk bootstrap`
-  - `cdk deploy`
-
-
+# Bishop CDK Construct Library
+
+## Bishop Constructs <a name="Constructs" id="Constructs"></a>
+
+Bishop Constructs is a construct library for creating new AWS Infrastructure in a standardize
+reusable manner. 
+
+[![Publish package to GitHub Packages](https://github.com/DavisSylvester/aws-constructs/actions/workflows/publish.yaml/badge.svg?branch=main)](https://github.com/DavisSylvester/aws-constructs/actions/workflows/publish.yaml)
+
+### Available Constructors
+
+ - [Microservice](#microservice-construct)
+
+And more...
+
+## Installation
+
+1. Install the npm package:
+
+    `npm install @davissylvester/bishop-cdk-constructs --save`
+    - *ensure you have a `.npmrc` that uses the @sylvesterllc npm registry*
+
+
+
+# Microservice Construct
+The Microservice construct provides and easy way to get started with a basic Microservice.
+
+#### Infrastructure
+    - API Gateway (Rest API)
+    - Lambda 
+    - Dynamodb
+    - Lambda Authorizer 
+      - TokenAuthorizer
+
+#### Access 
+*All lambdas are created with Read/Write Access to DynamoDB tables*
+
+### Usage
+```typescript
+import { MicroService, MicroserviceProps } from '@davissylvester/bishop-cdk-constructs';
+
+new MicroService(this, 'microservice-test', microServiceProps);
+```
+
+ ## MicroserviceProps
+
+ ```json
+ const microServiceProps: MicroserviceProps = {
+      GLOBALS: {
+          name: `sample-test-app`,
+          environments: "dev",
+          stackRuntime: Runtime.NODEJS_18_X,          
+      },
+      API: {
+          Name: `sample-test-app`,
+          Description: 'This is my new API'
+      },
+      RESOURCES: {
+          AUTHORIZER: {
+            name: `jwt-authorizer`,
+            codePath: './lambda-functions/authorizer/index.ts',
+            handler: 'handler',
+            apiPathRoot: '',
+            route: '',
+        }, 
+          LAMBDA: [
+              {
+                  name: `hello-world`,
+                  codePath: './lambda-functions/hello-world/index.ts',
+                  handler: 'main',
+                  method: 'get',
+                  apiPathRoot: 'hello-world',
+                  route: '/hello-world'
+              },
+              {
+                  name: `hellow-world2`,
+                  codePath: './lambda-functions/hello-world/index.ts',
+                  handler: 'main',
+                  method: 'get',
+                  apiPathRoot: '/hello-world/2',
+                  route: '/hello-world/2'
+              },
+              {
+                name: `hello-world3`,
+                codePath: './lambda-functions/hello-world/index.ts',
+                handler: 'main',
+                method: 'get',
+                apiPathRoot: '/hello-world/2',
+                route: '/hello-world/2/{id}',
+                secure: true
+            },
+          ],
+          DYNAMO: {
+              TABLES: [
+                  {
+                      tableName: `sample-audit-history`,
+                      primaryKey: {
+                          name: 'id',
+                          type: AttributeType.STRING,
+                      },
+                      billingMode: BillingMode.PAY_PER_REQUEST,
+                      indexes: [
+                          {
+                              indexName: 'createdTS',
+                              partitionKey: {
+                                  name: 'createdTS',
+                                  type: AttributeType.NUMBER
+                              },
+                              projectionType: ProjectionType.ALL
+                          },
+                          {
+                              indexName: 'username',
+                              partitionKey: {
+                                  name: 'username',
+                                  type: AttributeType.STRING
+                              },
+                              projectionType: ProjectionType.ALL
+                          },
+                      ]
+                  },
+              ],
+          },
+  
+      }
+  }; 
+ ```
+
+
+## Best Practice
+When using this library it is a good practice to start with a new CDK project
+   
+   - `npm install -g typescript aws-cdk`
+   - `mkdir my-new-project`
+   - `cd my-new-project`
+   - `cdk init app --language typescript`
+   - `npm i @davissylvester/bishop-cdk-constructs`
+   - `mkdir lambda-functions` (*holds all your lambda code*)
+
+# [Demo Project](https://github.com/davissylvester/bishop-cdk-constructs-demo.git)
+
+- Clone the repository
+  - `git clone https://github.com/davissylvester/bishop-cdk-constructs-demo.git`
+  - `npm i`
+  - `cdk bootstrap`
+  - `cdk deploy`
+
+
 Release Version : `1.0.28`

package/src/config/AppConfig.ts

@@ -1,107 +1,107 @@
-import { config } from "process";
-import { ApiAppConfig } from "./customConfigs/ApiAppConfig";
-import { GlobalAppConfig } from "./customConfigs/GlobalAppConfig";
-import { IAppConfig } from "./customConfigs/IAppConfig";
-import { ResourceAppConfig } from "./customConfigs/ResourceAppConfig";
-import { TsgDynamoProp } from "./types";
-import { TsgDnsAppConfig } from "./types/TsgDnsConfig";
-import { TsgLambdaName } from "./types/TsgLambdaName";
-import { TsgLambdaProp } from "./types/TsgLambdaProp";
-
-export class AppConfig implements IAppConfig {
-
-    public API: ApiAppConfig;
-    public GLOBALS: GlobalAppConfig;
-    public RESOURCES: ResourceAppConfig;
-    public DNS?: TsgDnsAppConfig;
-
-
-    public lambdaConfigs: TsgLambdaProp[];
-    public dynamoConfigs: TsgDynamoProp[];
-
-    get AppName() {
-        return this.GLOBALS.name;
-    }
-
-    get AppPrefix() {
-        return (this.GLOBALS.prefix) ? this.GLOBALS.prefix : this.GLOBALS.name;
-    }
-
-    constructor(config: IAppConfig) {
-        this.populate(config);
-    }
-
-    private populate(config: IAppConfig) {
-        this.populateGlobalConfig(config);
-        this.populateApiConfig(config);
-        this.populateResources(config);
-
-
-    }
-
-    private populateGlobalConfig(config: IAppConfig) {
-        this.GLOBALS = {
-            ...config.GLOBALS
-        };
-    }
-
-    private populateApiConfig(config: IAppConfig) {
-
-        if (config.API)
-            this.API = {
-                ...config.API
-            };
-    }
-
-    private populateResources(config: IAppConfig) {
-        this.RESOURCES = {
-            ...config.RESOURCES
-        };
-        this.RESOURCES.DYNAMO = {
-            ...config.RESOURCES.DYNAMO
-        };
-
-        if (config.DNS) {
-            this.DNS = {
-                ...config.DNS!
-            };
-        }
-
-        if (config.RESOURCES.AUTHORIZER) {
-            this.RESOURCES.AUTHORIZER = {
-                ...config.RESOURCES.AUTHORIZER
-            };
-        }
-
-        if (config.RESOURCES.EC2) {
-            this.RESOURCES.EC2 = {
-                ...config.RESOURCES.EC2
-            };
-        }
-
-    }
-    //     this.lambdaConfigs = this.expandProps<TsgLambdaName, TsgLambdaProp>(this.RESOURCES.LAMBDA!);
-    //     this.dynamoConfigs = this.expandProps<TsgTableName, TsgDynamoProp>(this.RESOURCES.DYNAMO?.TABLES!);
-    // }
-
-    private populateConfigs<T, R>(result: R[], record?: Record<string, R>) {
-
-        if (!record) {
-            return null;
-        }
-
-        result = this.expandProps<T, R>(record);
-        return result;
-
-    }
-
-    private expandProps<T, R>(data: Record<string, R>) {
-
-        const result = [];
-        // @ts-ignore
-        for (const [key, value] of Object.entries(data)) {
-            result.push(value);
-        }
-        return result as R[];
-    }
+import { config } from "process";
+import { ApiAppConfig } from "./customConfigs/ApiAppConfig";
+import { GlobalAppConfig } from "./customConfigs/GlobalAppConfig";
+import { IAppConfig } from "./customConfigs/IAppConfig";
+import { ResourceAppConfig } from "./customConfigs/ResourceAppConfig";
+import { TsgDynamoProp } from "./types";
+import { TsgDnsAppConfig } from "./types/TsgDnsConfig";
+import { TsgLambdaName } from "./types/TsgLambdaName";
+import { TsgLambdaProp } from "./types/TsgLambdaProp";
+
+export class AppConfig implements IAppConfig {
+
+    public API: ApiAppConfig;
+    public GLOBALS: GlobalAppConfig;
+    public RESOURCES: ResourceAppConfig;
+    public DNS?: TsgDnsAppConfig;
+
+
+    public lambdaConfigs: TsgLambdaProp[];
+    public dynamoConfigs: TsgDynamoProp[];
+
+    get AppName() {
+        return this.GLOBALS.name;
+    }
+
+    get AppPrefix() {
+        return (this.GLOBALS.prefix) ? this.GLOBALS.prefix : this.GLOBALS.name;
+    }
+
+    constructor(config: IAppConfig) {
+        this.populate(config);
+    }
+
+    private populate(config: IAppConfig) {
+        this.populateGlobalConfig(config);
+        this.populateApiConfig(config);
+        this.populateResources(config);
+
+
+    }
+
+    private populateGlobalConfig(config: IAppConfig) {
+        this.GLOBALS = {
+            ...config.GLOBALS
+        };
+    }
+
+    private populateApiConfig(config: IAppConfig) {
+
+        if (config.API)
+            this.API = {
+                ...config.API
+            };
+    }
+
+    private populateResources(config: IAppConfig) {
+        this.RESOURCES = {
+            ...config.RESOURCES
+        };
+        this.RESOURCES.DYNAMO = {
+            ...config.RESOURCES.DYNAMO
+        };
+
+        if (config.DNS) {
+            this.DNS = {
+                ...config.DNS!
+            };
+        }
+
+        if (config.RESOURCES.AUTHORIZER) {
+            this.RESOURCES.AUTHORIZER = {
+                ...config.RESOURCES.AUTHORIZER
+            };
+        }
+
+        if (config.RESOURCES.EC2) {
+            this.RESOURCES.EC2 = {
+                ...config.RESOURCES.EC2
+            };
+        }
+
+    }
+    //     this.lambdaConfigs = this.expandProps<TsgLambdaName, TsgLambdaProp>(this.RESOURCES.LAMBDA!);
+    //     this.dynamoConfigs = this.expandProps<TsgTableName, TsgDynamoProp>(this.RESOURCES.DYNAMO?.TABLES!);
+    // }
+
+    private populateConfigs<T, R>(result: R[], record?: Record<string, R>) {
+
+        if (!record) {
+            return null;
+        }
+
+        result = this.expandProps<T, R>(record);
+        return result;
+
+    }
+
+    private expandProps<T, R>(data: Record<string, R>) {
+
+        const result = [];
+        // @ts-ignore
+        for (const [key, value] of Object.entries(data)) {
+            result.push(value);
+        }
+        return result as R[];
+    }
 }

package/src/config/Constants.ts

@@ -1,27 +1,27 @@
-export const CONSTANTS = {
-
-    DYNAMODB: {
-        TABLES: {
-            AUTH_HISTORY_TABLE: {
-                name: 'auth-history',
-                indexes: {
-                    AuthHistoryTS: {
-                        name: 'auth-history-ts'
-                    },
-                    Username: {
-                        name: 'username',
-                    }
-                }
-            }
-        },
-    },
-    WEB: {
-        ADMIN_PORTAL_BUCKET: 'bishop.davissylvester.net',
-    },
-    AUTH:{
-        OAUTH: {
-            CLIENT_ID: process.env.AMAZON_OAUTH_CLIENT_ID,
-            CLIENT_SECRET: process.env.AMAZON_OAUTH_CLIENT_SECRET
-        }
-    }
+export const CONSTANTS = {
+
+    DYNAMODB: {
+        TABLES: {
+            AUTH_HISTORY_TABLE: {
+                name: 'auth-history',
+                indexes: {
+                    AuthHistoryTS: {
+                        name: 'auth-history-ts'
+                    },
+                    Username: {
+                        name: 'username',
+                    }
+                }
+            }
+        },
+    },
+    WEB: {
+        ADMIN_PORTAL_BUCKET: 'bishop.davissylvester.net',
+    },
+    AUTH:{
+        OAUTH: {
+            CLIENT_ID: process.env.AMAZON_OAUTH_CLIENT_ID,
+            CLIENT_SECRET: process.env.AMAZON_OAUTH_CLIENT_SECRET
+        }
+    }
 };

package/src/config/Environments.ts

@@ -1,2 +1,2 @@
-export type Environment = "dev" | "qa" | "prod";
+export type Environment = "dev" | "qa" | "prod";
 export type ClientAppType = "mobile" | "web";

package/src/config/MicroserviceAppConfig.ts

@@ -1,9 +1,9 @@
-import { MicroserviceProps } from "../interfaces/MicroserviceProps";
-import { AppConfig } from "./AppConfig";
-
-export class MicroServiceAppConfig extends AppConfig {
-
-   constructor(config: MicroserviceProps) {
-       super(config);
-   }
+import { MicroserviceProps } from "../interfaces/MicroserviceProps";
+import { AppConfig } from "./AppConfig";
+
+export class MicroServiceAppConfig extends AppConfig {
+
+   constructor(config: MicroserviceProps) {
+       super(config);
+   }
 }

package/src/config/ServiceBundleConfig.ts

@@ -1,18 +1,18 @@
-import { IRestApi } from "aws-cdk-lib/aws-apigateway";
-import { Construct } from "constructs";
-import { MicroserviceProps } from "../interfaces/MicroserviceProps";
-import { AppConfig } from "./AppConfig";
-import { Table } from "aws-cdk-lib/aws-dynamodb";
-import { ISecret } from "aws-cdk-lib/aws-secretsmanager";
-import { LayerVersion } from "aws-cdk-lib/aws-lambda";
-
-export interface ServiceBundleConfig {
-    scope: Construct, 
-    readonly gatewayApi: IRestApi, 
-    readonly props: MicroserviceProps,        
-    readonly appConfig: AppConfig,
-    readonly tables?: Table[], 
-    readonly secretMgr?: ISecret, 
-    readonly layers?: LayerVersion[]
-
+import { IRestApi } from "aws-cdk-lib/aws-apigateway";
+import { Construct } from "constructs";
+import { MicroserviceProps } from "../interfaces/MicroserviceProps";
+import { AppConfig } from "./AppConfig";
+import { Table } from "aws-cdk-lib/aws-dynamodb";
+import { ISecret } from "aws-cdk-lib/aws-secretsmanager";
+import { LayerVersion } from "aws-cdk-lib/aws-lambda";
+
+export interface ServiceBundleConfig {
+    scope: Construct, 
+    readonly gatewayApi: IRestApi, 
+    readonly props: MicroserviceProps,        
+    readonly appConfig: AppConfig,
+    readonly tables?: Table[], 
+    readonly secretMgr?: ISecret, 
+    readonly layers?: LayerVersion[]
+
 }