@sylvesterllc/aws-constructs 1.1.27 → 1.1.29

package/src/constructs/MicroService.ts

@@ -1,132 +1,132 @@
-import { Table } from "aws-cdk-lib/aws-dynamodb";
-import { Construct } from "constructs";
-import { MicroserviceProps } from "../interfaces/MicroserviceProps";
-import { CreateDynamoDb } from "../resources/dynamodb/CreateDynamo";
-import { Api } from "../resources/gateway/createApi";
-import { getSecretManager } from "../resources/securityManager";
-import { createCommonLayer } from "../resources/helpers/createCommonLayer";
-import { AppConfig } from "../config/AppConfig";
-import { Tags } from "aws-cdk-lib";
-import { LayerVersion } from "aws-cdk-lib/aws-lambda";
-import { CreateApiAndAttachLambdas } from "../resources/gateway/CreateApiAndAttachLambdas";
-import { createSeedDatabaseCustomResource } from "../resources/customResource/createSeedDatabaseCustomResource";
-import { IRestApi } from "aws-cdk-lib/aws-apigateway";
-import { ISecret } from "aws-cdk-lib/aws-secretsmanager";
-import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
-
-export class MicroService extends Construct {
-
-    protected readonly requireDynamoTables: boolean;
-    protected requireSeedDatabase: boolean = false;
-    protected readonly hasLambdaLayers: boolean = false;
-    protected appConfig: AppConfig;
-    private readonly api: IRestApi;
-    private readonly dynamoTables: Table[] | undefined;
-    private readonly lambdaLayers: LayerVersion[] | undefined;
-    private readonly secretManager: ISecret | null = null;
-    private readonly lambdas: NodejsFunction[] = [];
-    private lambdaRecords: Record<string, NodejsFunction> = {};
-
-    public get Tables() {
-        return this.dynamoTables;
-    }
-
-    public get SecretManager() {
-        return this.secretManager;
-    }
-
-    public get LambdaLayers() {
-        return this.lambdaLayers;
-    }
-
-    public get Lambdas() {
-        return this.lambdas;
-    }
-
-    public get LambdaRecords() {
-        return this.lambdaRecords;
-    }
-
-    public get RestApi() {
-        return this.api;
-    }
-
-    constructor(scope: Construct, id: string, props: MicroserviceProps,
-        private env: string) {
-        super(scope, id);
-
-        this.appConfig = new AppConfig(props);
-
-        this.requireDynamoTables = (props.RESOURCES.DYNAMO?.TABLES &&
-            props.RESOURCES.DYNAMO.TABLES.length > 0) ? true : false;
-
-        this.requireSeedDatabase = (props.RESOURCES.DYNAMO?.USE_SEED_DATABASE &&
-            props.RESOURCES.DYNAMO.SEED_LAMBDA) ? true : false;
-
-        this.hasLambdaLayers = (props.RESOURCES.LAMBDA_LAYERS &&
-            props.RESOURCES.LAMBDA_LAYERS.length > 0) ? true : false;
-
-        const results = this.onInit(scope);
-
-        this.api = results.restApi!;
-        this.dynamoTables = results.dynamoTables!;
-        this.lambdaLayers = results.lambdaLayers!;
-        this.secretManager = results.secretManager!;
-
-        this.lambdas = results.lambdas!;
-
-        this.createTag(scope)
-    }
-
-    private onInit(scope: Construct) {
-
-        let secretManager: ISecret | null = null;
-        let tables: Table[] | undefined = undefined;
-        let commonLayers: LayerVersion[] | undefined = undefined;
-
-        if (process.env.SECRET_MANAGER_ARN) {
-            // throw new Error(`You must provide the ARN for the your Configuration Secret 
-            //     Manager`);      
-            secretManager = getSecretManager(scope, this.appConfig, process.env.SECRET_MANAGER_ARN);
-        }
-
-        if (this.hasLambdaLayers) {
-            commonLayers = createCommonLayer(scope, this.appConfig);
-        }
-
-        const gateway = new Api(scope, this.appConfig, this.env).APIs;
-
-        const layers = commonLayers;
-
-        // Creates DynamoDb Tables if required
-        if (this.requireDynamoTables) {
-            const dynamo = new CreateDynamoDb(scope, this.appConfig);
-
-            tables = dynamo.CreatedTables;
-        }
-
-        if (this.requireSeedDatabase) {
-            createSeedDatabaseCustomResource(scope, this.appConfig, tables![0], layers);
-        }
-
-        // CREATE API GATEWAY AND LAMBDA HERE 
-        const apiGateway = new CreateApiAndAttachLambdas(scope, this.appConfig, gateway[0], layers, tables);
-
-        this.lambdaRecords = apiGateway.LambdaRecords;
-
-        return {
-            restApi: (gateway?.length > 0) ? gateway[0] : null,
-            lambdaLayers: layers || null,
-            dynamoTables: tables || null,
-            secretManager: secretManager,
-            lambdas: apiGateway.Lambdas,
-
-        };
-
-    }
-
-    protected createTag(scope: Construct) {
-        Tags.of(scope).add('App', this.appConfig.AppName);
-        Tags.of(scope).add('ResoucePrefix', this.appConfig.AppPrefix);
-    }
+import { Table } from "aws-cdk-lib/aws-dynamodb";
+import { Construct } from "constructs";
+import { MicroserviceProps } from "../interfaces/MicroserviceProps";
+import { CreateDynamoDb } from "../resources/dynamodb/CreateDynamo";
+import { Api } from "../resources/gateway/createApi";
+import { getSecretManager } from "../resources/securityManager";
+import { createCommonLayer } from "../resources/helpers/createCommonLayer";
+import { AppConfig } from "../config/AppConfig";
+import { Tags } from "aws-cdk-lib";
+import { LayerVersion } from "aws-cdk-lib/aws-lambda";
+import { CreateApiAndAttachLambdas } from "../resources/gateway/CreateApiAndAttachLambdas";
+import { createSeedDatabaseCustomResource } from "../resources/customResource/createSeedDatabaseCustomResource";
+import { IRestApi } from "aws-cdk-lib/aws-apigateway";
+import { ISecret } from "aws-cdk-lib/aws-secretsmanager";
+import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
+
+export class MicroService extends Construct {
+
+    protected readonly requireDynamoTables: boolean;
+    protected requireSeedDatabase: boolean = false;
+    protected readonly hasLambdaLayers: boolean = false;
+    protected appConfig: AppConfig;
+    private readonly api: IRestApi;
+    private readonly dynamoTables: Table[] | undefined;
+    private readonly lambdaLayers: LayerVersion[] | undefined;
+    private readonly secretManager: ISecret | null = null;
+    private readonly lambdas: NodejsFunction[] = [];
+    private lambdaRecords: Record<string, NodejsFunction> = {};
+
+    public get Tables() {
+        return this.dynamoTables;
+    }
+
+    public get SecretManager() {
+        return this.secretManager;
+    }
+
+    public get LambdaLayers() {
+        return this.lambdaLayers;
+    }
+
+    public get Lambdas() {
+        return this.lambdas;
+    }
+
+    public get LambdaRecords() {
+        return this.lambdaRecords;
+    }
+
+    public get RestApi() {
+        return this.api;
+    }
+
+    constructor(scope: Construct, id: string, props: MicroserviceProps,
+        private env: string) {
+        super(scope, id);
+
+        this.appConfig = new AppConfig(props);
+
+        this.requireDynamoTables = (props.RESOURCES.DYNAMO?.TABLES &&
+            props.RESOURCES.DYNAMO.TABLES.length > 0) ? true : false;
+
+        this.requireSeedDatabase = (props.RESOURCES.DYNAMO?.USE_SEED_DATABASE &&
+            props.RESOURCES.DYNAMO.SEED_LAMBDA) ? true : false;
+
+        this.hasLambdaLayers = (props.RESOURCES.LAMBDA_LAYERS &&
+            props.RESOURCES.LAMBDA_LAYERS.length > 0) ? true : false;
+
+        const results = this.onInit(scope);
+
+        this.api = results.restApi!;
+        this.dynamoTables = results.dynamoTables!;
+        this.lambdaLayers = results.lambdaLayers!;
+        this.secretManager = results.secretManager!;
+
+        this.lambdas = results.lambdas!;
+
+        this.createTag(scope)
+    }
+
+    private onInit(scope: Construct) {
+
+        let secretManager: ISecret | null = null;
+        let tables: Table[] | undefined = undefined;
+        let commonLayers: LayerVersion[] | undefined = undefined;
+
+        if (process.env.SECRET_MANAGER_ARN) {
+            // throw new Error(`You must provide the ARN for the your Configuration Secret 
+            //     Manager`);      
+            secretManager = getSecretManager(scope, this.appConfig, process.env.SECRET_MANAGER_ARN);
+        }
+
+        if (this.hasLambdaLayers) {
+            commonLayers = createCommonLayer(scope, this.appConfig);
+        }
+
+        const gateway = new Api(scope, this.appConfig, this.env).APIs;
+
+        const layers = commonLayers;
+
+        // Creates DynamoDb Tables if required
+        if (this.requireDynamoTables) {
+            const dynamo = new CreateDynamoDb(scope, this.appConfig);
+
+            tables = dynamo.CreatedTables;
+        }
+
+        if (this.requireSeedDatabase) {
+            createSeedDatabaseCustomResource(scope, this.appConfig, tables![0], layers);
+        }
+
+        // CREATE API GATEWAY AND LAMBDA HERE 
+        const apiGateway = new CreateApiAndAttachLambdas(scope, this.appConfig, gateway[0], layers, tables);
+
+        this.lambdaRecords = apiGateway.LambdaRecords;
+
+        return {
+            restApi: (gateway?.length > 0) ? gateway[0] : null,
+            lambdaLayers: layers || null,
+            dynamoTables: tables || null,
+            secretManager: secretManager,
+            lambdas: apiGateway.Lambdas,
+
+        };
+
+    }
+
+    protected createTag(scope: Construct) {
+        Tags.of(scope).add('App', this.appConfig.AppName);
+        Tags.of(scope).add('ResoucePrefix', this.appConfig.AppPrefix);
+    }
 }

package/src/constructs/index.ts

@@ -1,5 +1,5 @@
-export { MicroService } from "./MicroService";
-export { TsgAuthorizerType } from "../config/types/TsgAuthorizerType";
-export { DynamoDbSingleTable } from "./DynamoDbSingleTable";
-export { TimerJob } from "./timer-job";
-export { BasicLambda } from "./BasicLambda";
+export { MicroService } from "./MicroService";
+export { TsgAuthorizerType } from "../config/types/TsgAuthorizerType";
+export { DynamoDbSingleTable } from "./DynamoDbSingleTable";
+export { TimerJob } from "./timer-job";
+export { BasicLambda } from "./BasicLambda";

package/src/constructs/timer-job.ts

@@ -1,19 +1,19 @@
-import { Construct } from "constructs";
-import { TimerJobProps } from "../interfaces/timer-job";
-import { createBasicLambdaTimerJob } from "../resources/lambda/create-basic-lambda.js";
-import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
-
-export class TimerJob extends Construct {
-  public readonly lambdaFunction: NodejsFunction;
-
-  constructor(
-    scope: Construct,
-    id: string,
-    props: TimerJobProps,
-    private env: string
-  ) {
-    super(scope, id);
-
-    this.lambdaFunction = createBasicLambdaTimerJob(scope, props);
-  }
-}
+import { Construct } from "constructs";
+import { TimerJobProps } from "../interfaces/timer-job";
+import { createBasicLambdaTimerJob } from "../resources/lambda/create-basic-lambda.js";
+import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
+
+export class TimerJob extends Construct {
+  public readonly lambdaFunction: NodejsFunction;
+
+  constructor(
+    scope: Construct,
+    id: string,
+    props: TimerJobProps,
+    private env: string
+  ) {
+    super(scope, id);
+
+    this.lambdaFunction = createBasicLambdaTimerJob(scope, props);
+  }
+}

package/src/helpers/logger.ts

@@ -1,13 +1,13 @@
-import { debug } from "console";
-
-export class Logger {
-
-    constructor(private debug: boolean = false) { }
-
-    public log(message: string) {
-
-        if (this.debug) {
-            console.log(message);
-        }
-    }
+import { debug } from "console";
+
+export class Logger {
+
+    constructor(private debug: boolean = false) { }
+
+    public log(message: string) {
+
+        if (this.debug) {
+            console.log(message);
+        }
+    }
 }

package/src/helpers/util-helper.ts

@@ -1,20 +1,20 @@
-import { v4 as uuidv4 } from 'uuid';
-import { Environment } from '../config/Environments';
-
-export const getUUID = () => {
-
-    return uuidv4();
-};
-
-export const environmentSuffix = (env: Environment = "prod") => {
-    return env === 'prod' ? '' : env === 'qa' ? '-qa' : '-dev';
-}
-
-export const environmentSuffixForDomain = (env: Environment = "prod") => {
-    return env === 'prod' ? '.' : env === 'qa' ? '.qa' : '.dev';
-}
-
-export const clog = (message: string) => {
-
-
+import { v4 as uuidv4 } from 'uuid';
+import { Environment } from '../config/Environments';
+
+export const getUUID = () => {
+
+    return uuidv4();
+};
+
+export const environmentSuffix = (env: Environment = "prod") => {
+    return env === 'prod' ? '' : env === 'qa' ? '-qa' : '-dev';
+}
+
+export const environmentSuffixForDomain = (env: Environment = "prod") => {
+    return env === 'prod' ? '.' : env === 'qa' ? '.qa' : '.dev';
+}
+
+export const clog = (message: string) => {
+
+
 };

package/src/index.ts

@@ -1,8 +1,8 @@
-export { MicroService } from "./constructs/MicroService";
-export { MicroserviceProps } from "./interfaces/MicroserviceProps";
-export { IAppConfig } from "./config/customConfigs/IAppConfig";
-export { MicroServiceAppConfig } from "./config/MicroserviceAppConfig";
-export { TsgAuthorizerType } from "./config/types/TsgAuthorizerType";
-export * from "./interfaces/timer-job/index";
-export * from "./interfaces/lambda/index";
-export * from "./constructs/index";
+export { MicroService } from "./constructs/MicroService";
+export { MicroserviceProps } from "./interfaces/MicroserviceProps";
+export { IAppConfig } from "./config/customConfigs/IAppConfig";
+export { MicroServiceAppConfig } from "./config/MicroserviceAppConfig";
+export { TsgAuthorizerType } from "./config/types/TsgAuthorizerType";
+export * from "./interfaces/timer-job/index";
+export * from "./interfaces/lambda/index";
+export * from "./constructs/index";

package/src/interfaces/ApiLambdaResult.ts

@@ -1,7 +1,7 @@
-import { Token } from "aws-cdk-lib";
-import { IRestApi, RequestAuthorizer, TokenAuthorizer } from "aws-cdk-lib/aws-apigateway";
-
-export interface ApiLambdaResult {
-    api:  IRestApi;
-    authorizer: TokenAuthorizer | RequestAuthorizer | undefined | null;
+import { Token } from "aws-cdk-lib";
+import { IRestApi, RequestAuthorizer, TokenAuthorizer } from "aws-cdk-lib/aws-apigateway";
+
+export interface ApiLambdaResult {
+    api:  IRestApi;
+    authorizer: TokenAuthorizer | RequestAuthorizer | undefined | null;
 }

package/src/interfaces/BaseResourceProps.ts

@@ -1,7 +1,7 @@
-import { Construct } from "constructs";
-import { AppConfig } from "../config/AppConfig";
-
-export interface BaseResourceProps {
-    scope: Construct;
-    config: AppConfig
+import { Construct } from "constructs";
+import { AppConfig } from "../config/AppConfig";
+
+export interface BaseResourceProps {
+    scope: Construct;
+    config: AppConfig
 }

package/src/interfaces/CreateLambdaFunctionInput.ts

@@ -1,11 +1,11 @@
-import { IRole } from "aws-cdk-lib/aws-iam";
-import { LayerVersion } from "aws-cdk-lib/aws-lambda";
-import { TsgLambdaProp } from "../config/types";
-import { TsgLambdaProps } from "../config/types/TsgLambdaProps";
-
-export interface CreateLambdaFunctionInput {
-    prop: TsgLambdaProp;
-    role?: IRole;
-    layers?: LayerVersion[],
-    props?: TsgLambdaProps
+import { IRole } from "aws-cdk-lib/aws-iam";
+import { LayerVersion } from "aws-cdk-lib/aws-lambda";
+import { TsgLambdaProp } from "../config/types";
+import { TsgLambdaProps } from "../config/types/TsgLambdaProps";
+
+export interface CreateLambdaFunctionInput {
+    prop: TsgLambdaProp;
+    role?: IRole;
+    layers?: LayerVersion[],
+    props?: TsgLambdaProps
 }

package/src/interfaces/MicroserviceProps.ts

@@ -1,11 +1,11 @@
-import { ApiAppConfig } from "../config/customConfigs/ApiAppConfig";
-import { GlobalAppConfig } from "../config/customConfigs/GlobalAppConfig";
-import { ResourceAppConfig } from "../config/customConfigs/ResourceAppConfig";
-import { TsgDnsAppConfig } from "../config/types/TsgDnsConfig";
-
-export interface MicroserviceProps {
-    API: ApiAppConfig;
-    GLOBALS: GlobalAppConfig;
-    RESOURCES: ResourceAppConfig;
-    DNS?: TsgDnsAppConfig;
+import { ApiAppConfig } from "../config/customConfigs/ApiAppConfig";
+import { GlobalAppConfig } from "../config/customConfigs/GlobalAppConfig";
+import { ResourceAppConfig } from "../config/customConfigs/ResourceAppConfig";
+import { TsgDnsAppConfig } from "../config/types/TsgDnsConfig";
+
+export interface MicroserviceProps {
+    API: ApiAppConfig;
+    GLOBALS: GlobalAppConfig;
+    RESOURCES: ResourceAppConfig;
+    DNS?: TsgDnsAppConfig;
 }

package/src/interfaces/lambda/index.ts

@@ -1 +1 @@
-export { LambdaProps } from "./lambda-props";
+export { LambdaProps } from "./lambda-props";

package/src/interfaces/lambda/lambda-props.ts

@@ -1,15 +1,15 @@
-import { IRole } from "aws-cdk-lib/aws-iam/lib";
-
-export interface LambdaProps {
-  functionName: string;
-  appPrefix?: string;
-  codePath?: string;
-  memory?: number;
-  envs?: Record<string, string>;
-  role?: IRole;
-  dynamoTableNames?: string[];
-  lambdaLayerArn?: string[];
-  projectRoot?: string;
-  depsLockFilePath?: string;
-  timeoutInMinutes?: number;
-}
+import { IRole } from "aws-cdk-lib/aws-iam/lib";
+
+export interface LambdaProps {
+  functionName: string;
+  appPrefix?: string;
+  codePath?: string;
+  memory?: number;
+  envs?: Record<string, string>;
+  role?: IRole;
+  dynamoTableNames?: string[];
+  lambdaLayerArn?: string[];
+  projectRoot?: string;
+  depsLockFilePath?: string;
+  timeoutInMinutes?: number;
+}

package/src/interfaces/timer-job/timer-job-props.ts

@@ -1,6 +1,6 @@
-import { CronOptions } from "aws-cdk-lib/aws-events/lib/schedule";
-import { LambdaProps } from "../lambda";
-
-export interface TimerJobProps extends LambdaProps {
-  cronOptions: CronOptions;
-}
+import { CronOptions } from "aws-cdk-lib/aws-events/lib/schedule";
+import { LambdaProps } from "../lambda";
+
+export interface TimerJobProps extends LambdaProps {
+  cronOptions: CronOptions;
+}

package/src/resources/base/baseResource.ts

@@ -1,15 +1,15 @@
-import { Tags } from "aws-cdk-lib";
-import { Construct } from "constructs";
-import { AppConfig } from "../../config/AppConfig";
-
-export abstract class BaseResource<T> {
-
-    protected createdResources: T[];
-
-    constructor(protected scope: Construct, protected config: AppConfig) { }
-
-    protected abstract createResource(scope: Construct): T[] | null;
-    
-    protected abstract createOutput<T>(scope: Construct, createdAssets: T[]): void;
-    
+import { Tags } from "aws-cdk-lib";
+import { Construct } from "constructs";
+import { AppConfig } from "../../config/AppConfig";
+
+export abstract class BaseResource<T> {
+
+    protected createdResources: T[];
+
+    constructor(protected scope: Construct, protected config: AppConfig) { }
+
+    protected abstract createResource(scope: Construct): T[] | null;
+    
+    protected abstract createOutput<T>(scope: Construct, createdAssets: T[]): void;
+    
 }

package/src/resources/base/tsgBaseResource.ts

@@ -1,22 +1,22 @@
-import { CfnOutput } from "aws-cdk-lib";
-import { Construct } from "constructs";
-
-export abstract class TsgBaseResource<T, R> {
-
-    protected createdResource: T | null;
-
-    constructor(protected scope: Construct, protected config: R) {
-
-        this.createdResource = this.createResource(scope);
-
-        if (this.createdResource) {
-            this.createOutput(scope);
-        }
-    }
-
-
-    protected abstract createResource(scope: Construct): T | null;
-
-    protected abstract createOutput<T>(scope: Construct): void;
-
+import { CfnOutput } from "aws-cdk-lib";
+import { Construct } from "constructs";
+
+export abstract class TsgBaseResource<T, R> {
+
+    protected createdResource: T | null;
+
+    constructor(protected scope: Construct, protected config: R) {
+
+        this.createdResource = this.createResource(scope);
+
+        if (this.createdResource) {
+            this.createOutput(scope);
+        }
+    }
+
+
+    protected abstract createResource(scope: Construct): T | null;
+
+    protected abstract createOutput<T>(scope: Construct): void;
+
 }