@byaga/cdk-patterns 0.8.5 → 0.9.0

package/lib/DeployStack.d.ts

@@ -10,7 +10,9 @@ export declare class DeployStack extends Stack {
     stage: string;
     name: string;
     genName(...name: string[]): string;
+    genStackName(stackName: string, ...name: string[]): string;
     genId(...name: string[]): string;
+    genStackId(stackName: string, ...name: string[]): string;
     static genStackResourceName(stackName: string, resource: string, stage?: string): string;
     static genStackResourceId(stackName: string, resource: string, stage?: string): string;
     constructor(scope: IConstruct, props: IStackArguments);

package/lib/DeployStack.js

@@ -7,19 +7,25 @@ class DeployStack extends aws_cdk_lib_1.Stack {
     stage;
     name;
     genName(...name) {
-        return DeployStack.genStackResourceName(this.name, this.stage, name.filter(n => !!n).join('-'));
+        return DeployStack.genStackResourceName(this.name, name.filter(n => !!n).join('-'), this.stage);
+    }
+    genStackName(stackName, ...name) {
+        return DeployStack.genStackResourceName(stackName, name.filter(n => !!n).join('-'), this.stage);
     }
     genId(...name) {
-        return DeployStack.genStackResourceId(this.name, this.stage, name.filter(n => !!n).join('-'));
+        return DeployStack.genStackResourceId(this.name, name.filter(n => !!n).join('-'), this.stage);
+    }
+    genStackId(stackName, ...name) {
+        return DeployStack.genStackResourceId(stackName, name.filter(n => !!n).join('-'), this.stage);
     }
     static genStackResourceName(stackName, resource, stage = 'develop') {
-        let name = stackName[0].toLowerCase() + stackName.substr(1);
+        let name = stackName[0].toLowerCase() + stackName.substring(1);
         name = name.replace(/[A-Z]/g, v => '-' + v.toLowerCase());
-        return `${name}-${resource}-${stage}`.toLowerCase();
+        return `${name}-${stage}-${resource}`.toLowerCase();
     }
     static genStackResourceId(stackName, resource, stage = 'develop') {
-        const constructName = `${stackName}-${resource}-${stage}`;
-        return constructName[0].toUpperCase() + constructName.substr(1).replace(/-./g, v => (v[1] || '').toUpperCase());
+        const constructName = `${stackName}-${stage}-${resource}`;
+        return constructName[0].toUpperCase() + constructName.substring(1).replace(/-./g, v => (v[1] || '').toUpperCase());
     }
     constructor(scope, props) {
         const options = (props || {});

package/lib/StaticWebSite.d.ts

@@ -1,12 +1,17 @@
 /// <reference types="node" />
 import { DeployStack } from "./DeployStack";
+import { SourceConfiguration } from "aws-cdk-lib/aws-cloudfront";
 import IDomainConfig from "./IDomainConfig";
+import { IIgnoreOptions } from "./methods/walk-directory";
 interface StaticWebSiteConfig {
     srcDir?: string;
     domain: IDomainConfig;
     env: NodeJS.ProcessEnv;
+    ignore?: IIgnoreOptions;
+    proxy?: SourceConfiguration[];
 }
 export declare class StaticWebSite {
     constructor(stack: DeployStack, id: string, props: StaticWebSiteConfig);
+    static defineProxy(stack: DeployStack, domainName: string, pathPattern: string): SourceConfiguration;
 }
 export {};

package/lib/StaticWebSite.js

@@ -1,27 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -30,8 +7,6 @@ exports.StaticWebSite = void 0;
 const core_1 = require("aws-cdk-lib/core");
 const Output_1 = require("./Output");
 const child_process_1 = require("child_process");
-const fs = __importStar(require("fs-extra"));
-const path = __importStar(require("path"));
 const aws_s3_1 = require("aws-cdk-lib/aws-s3");
 const aws_s3_deployment_1 = require("aws-cdk-lib/aws-s3-deployment");
 const ApiCertificate_1 = __importDefault(require("./ApiCertificate"));
@@ -39,21 +14,30 @@ const aws_cloudfront_1 = require("aws-cdk-lib/aws-cloudfront");
 const aws_iam_1 = require("aws-cdk-lib/aws-iam");
 const aws_route53_1 = require("aws-cdk-lib/aws-route53");
 const aws_route53_targets_1 = require("aws-cdk-lib/aws-route53-targets");
+const duration_1 = __importDefault(require("./methods/duration"));
+const build_node_source_1 = require("./methods/build-node-source");
+const walk_directory_1 = require("./methods/walk-directory");
+const aws_cdk_lib_1 = require("aws-cdk-lib");
 class StaticWebSite {
     constructor(stack, id, props) {
         console.log('Deploying Static Web Site', id);
-        const srcDir = path.resolve("../src/", props.srcDir || '');
-        const buildDir = path.resolve("../dist/", props.srcDir || '');
-        console.log('Installing Prod Dependencies', id);
-        (0, child_process_1.execSync)('npm i --production --quiet', {
-            cwd: srcDir
+        const done = (0, duration_1.default)();
+        const childrenExcluded = props.ignore?.childrenExcluded || walk_directory_1.no;
+        const { buildDir, moduleChanged } = (0, build_node_source_1.buildNodeSource)('web', id, {
+            ignore: {
+                ...props.ignore,
+                childrenExcluded: stat => stat.name === 'out' || childrenExcluded(stat)
+            }
         });
-        console.log('Building UI Source', id);
-        (0, child_process_1.execSync)('npm run export', {
-            cwd: srcDir,
-            //env: props.env
-        });
-        fs.copySync(path.resolve(srcDir, "./out"), buildDir);
+        if (moduleChanged) {
+            console.log('Building UI Source', id);
+            (0, child_process_1.execSync)('npm run export', {
+                cwd: buildDir,
+                env: props.env
+            });
+        }
+        console.log('Total Build Duration (ms)', done());
+        const exportDir = buildDir + '/out';
         console.log('Creating HTTPS Certificate', id + '-certificate');
         const certificate = new ApiCertificate_1.default(stack, id + '-certificate', props.domain);
         console.log('Deploying Site Content Bucket', stack.genId(id, "content-bucket"));
@@ -61,7 +45,6 @@ class StaticWebSite {
             bucketName: certificate.domain,
             websiteIndexDocument: "index.html",
             websiteErrorDocument: "error.html",
-            publicReadAccess: true,
             removalPolicy: core_1.RemovalPolicy.DESTROY,
             autoDeleteObjects: true
         });
@@ -71,15 +54,15 @@ class StaticWebSite {
             resources: [s3BucketSource.bucketArn, s3BucketSource.bucketArn + '/*'],
         });
         new aws_s3_deployment_1.BucketDeployment(stack, stack.genId(id, 'bucket-deployment'), {
-            sources: [aws_s3_deployment_1.Source.asset(buildDir)],
+            sources: [aws_s3_deployment_1.Source.asset(exportDir)],
             destinationBucket: s3BucketSource
         });
         const originAccessIdentity = new aws_cloudfront_1.OriginAccessIdentity(stack, "WebsiteOAI");
         cloudFrontPolicy.addArnPrincipal(originAccessIdentity.cloudFrontOriginAccessIdentityS3CanonicalUserId);
+        s3BucketSource.grantRead(originAccessIdentity);
         const distro = new aws_cloudfront_1.CloudFrontWebDistribution(stack, stack.genId(id, 'cloudfront-web-distribution'), {
             enabled: true,
-            //priceClass:
-            originConfigs: [{
+            originConfigs: [...props.proxy || [], {
                     s3OriginSource: {
                         s3BucketSource,
                         originAccessIdentity
@@ -103,5 +86,41 @@ class StaticWebSite {
             target: aws_route53_1.RecordTarget.fromAlias(new aws_route53_targets_1.CloudFrontTarget(distro))
         });
     }
+    static defineProxy(stack, domainName, pathPattern) {
+        return {
+            customOriginSource: {
+                domainName: domainName,
+                originPath: stack.stage,
+                originProtocolPolicy: aws_cloudfront_1.OriginProtocolPolicy.HTTPS_ONLY
+            },
+            behaviors: [{
+                    pathPattern,
+                    allowedMethods: aws_cloudfront_1.CloudFrontAllowedMethods.ALL,
+                    maxTtl: aws_cdk_lib_1.Duration.seconds(0),
+                    minTtl: aws_cdk_lib_1.Duration.seconds(0),
+                    defaultTtl: aws_cdk_lib_1.Duration.seconds(0),
+                    compress: false,
+                    forwardedValues: {
+                        queryString: true,
+                        headers: [
+                            "Authorization",
+                            "User-Agent",
+                            "X-Trace-Id",
+                            "X-Span-Id",
+                            "X-Correlation-Id",
+                            'Referrer',
+                            'Referer',
+                            'Host',
+                            "User-Agent",
+                            "Accept-Language",
+                            "Cache-Control",
+                            'X-Viewer-Country',
+                            'Content-Type',
+                            'Content-Length'
+                        ]
+                    }
+                }]
+        };
+    }
 }
 exports.StaticWebSite = StaticWebSite;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byaga/cdk-patterns",
-  "version": "0.8.5",
+  "version": "0.9.0",
   "description": "Collection of common patterns used when making AWS CloudFormation templates using CDK",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -22,7 +22,7 @@
     "fs-extra": "^11.1.1"
   },
   "devDependencies": {
-    "@types/node": "^20.8.9",
+    "@types/node": "^20.8.10",
     "typescript": "^5.2.2"
   }
 }

package/.fleet/run.json

@@ -1,11 +0,0 @@
-{
-    "configurations": [
-        {
-            "type": "npm",
-            "name": "cdk-patterns build",
-            "command": "run",
-            "scripts": "build",
-        },
-
-    ]
-}

package/src/ApiCertificate.ts

@@ -1,32 +0,0 @@
-import {Certificate, CertificateValidation} from "aws-cdk-lib/aws-certificatemanager";
-import {HostedZone, IHostedZone} from "aws-cdk-lib/aws-route53";
-import {Output} from "./Output";
-import DeployStack from "./DeployStack";
-import IDomainConfig from "./IDomainConfig";
-
-export class ApiCertificate extends Certificate {
-    hostedZone: IHostedZone
-    domain: string
-
-    constructor(stack: DeployStack, id: string, domain: IDomainConfig) {
-        const certDomain = [domain.domainName]
-        if (domain.subdomain) certDomain.splice(0, 0, domain.subdomain)
-        const domainName = certDomain.join('.')
-
-        console.log('Getting Hosted Zone', domain.hostedZone.name)
-        const hostedZone: IHostedZone = HostedZone.fromHostedZoneAttributes(stack, stack.genId(id, 'hosted-zone'), {
-            hostedZoneId: domain.hostedZone.id,
-            zoneName: domain.hostedZone.name
-        })
-        console.log('Defining Certificate For', domainName)
-        super(stack, stack.genId(id), {
-            domainName,
-            validation: CertificateValidation.fromDns(hostedZone)
-        });
-
-        this.domain = domainName
-        new Output(stack, id, this.certificateArn)
-        this.hostedZone = hostedZone
-    }
-}
-export default ApiCertificate

package/src/CognitoApiGatewayAuthorizer.ts

@@ -1,25 +0,0 @@
-import { Construct } from 'constructs'
-import { CfnAuthorizer, IAuthorizer } from 'aws-cdk-lib/aws-apigateway'
-import { CfnAuthorizerProps } from 'aws-cdk-lib/aws-apigateway/lib/apigateway.generated'
-
-/**
- * Custom construct that implements a Cognito based API Gateway Authorizer.
- *
- * @see https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_author
- *
- * @see https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.CfnAuthorizer.html
- * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html
- * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
- * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enable-cognito-user-pool.html
- *
- * @see https://github.com/aws/aws-cdk/issues/5618#issuecomment-666922559
- */
-export class CognitoApiGatewayAuthorizer extends CfnAuthorizer implements IAuthorizer {
-    public readonly authorizerId: string
-
-    constructor(scope: Construct, id: string, props: CfnAuthorizerProps) {
-        super(scope, id, props)
-
-        this.authorizerId = this.ref
-    }
-}

package/src/DeployStack.ts

@@ -1,56 +0,0 @@
-import {Stack} from 'aws-cdk-lib';
-import IStackArguments from './IStackArguments'
-import {IConstruct} from "constructs";
-
-export class DeployStack extends Stack {
-    registry: { [t: string]: { [n: string]: any } } = {}
-    stage: string
-    name: string
-
-    genName(...name: string[]): string {
-        return DeployStack.genStackResourceName(this.name, this.stage, name.filter(n => !!n).join('-'))
-    }
-
-    genId(...name: string[]): string {
-        return DeployStack.genStackResourceId(this.name, this.stage, name.filter(n => !!n).join('-'))
-    }
-
-    static genStackResourceName(stackName: string, resource: string, stage = 'develop') {
-        let name = stackName[0].toLowerCase() + stackName.substr(1)
-        name = name.replace(/[A-Z]/g, v => '-' + v.toLowerCase())
-        return `${name}-${resource}-${stage}`.toLowerCase()
-    }
-
-    static genStackResourceId(stackName: string, resource: string, stage = 'develop') {
-        const constructName = `${stackName}-${resource}-${stage}`
-        return constructName[0].toUpperCase() + constructName.substr(1).replace(/-./g, v => (v[1] || '').toUpperCase())
-    }
-
-    constructor(scope: IConstruct, props: IStackArguments) {
-        const options = (props || {}) as IStackArguments
-        const {stage = 'develop'} = options
-        super(scope, props.stackName + '-' + stage, {
-            ...props,
-            stackName: props.stackName + '-' + stage
-        });
-        const stack = this;
-        stack.name = props.stackName || '';
-
-        stack.stage = stage;
-
-        stack.tags.setTag('Stage', stage);
-        stack.tags.setTag('Stack', this.genName('ui-stack'));
-    }
-
-    get(type: string, name: string) {
-        const items = this.registry[type]
-        return (items && items[name]) || null
-    }
-
-    set(type: string, name: string, instance: any) {
-        this.registry[type] = this.registry[type] || {};
-        this.registry[type][name] = instance;
-        return instance;
-    }
-}
-export default DeployStack

package/src/DynamoDbTable.ts

@@ -1,40 +0,0 @@
-import {CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
-import {Table, BillingMode, AttributeType} from 'aws-cdk-lib/aws-dynamodb'
-import {Effect, Policy, PolicyStatement} from "aws-cdk-lib/aws-iam";
-import {DeployStack} from "./DeployStack"
-
-interface DynamoDbTableConfig {
-    partitionKey: string,
-    sortKey?: string
-}
-
-export class DynamoDbTable extends Table {
-    getPolicy: Policy
-
-    constructor(stack: DeployStack, id: string, props: DynamoDbTableConfig) {
-        console.log('Creating DynamoDb Table', stack.genName(id, 'data-table'))
-        super(stack, stack.genId(id, 'data-table'), {
-            tableName: stack.genName(id, 'data-table'),
-            partitionKey: {name: props.partitionKey, type: AttributeType.STRING},
-            sortKey: props.sortKey ? {name: props.sortKey, type: AttributeType.STRING} : undefined,
-            billingMode: BillingMode.PAY_PER_REQUEST,
-            removalPolicy: RemovalPolicy.DESTROY
-        });
-    stack.set('dynamo', id, this)
-
-        new CfnOutput(stack, stack.genId(id, 'table'), {
-            value: this.tableName,
-            exportName: stack.genName(id, 'table')
-        })
-
-        this.getPolicy = new Policy(stack, stack.genId(id, 'get-policy'), {
-            statements: [
-                new PolicyStatement({
-                    actions: ['dynamodb:GetItem'],
-                    effect: Effect.ALLOW,
-                    resources: [this.tableArn]
-                })
-            ]
-        })
-    }
-}

package/src/FunctionIntegration.ts

@@ -1,93 +0,0 @@
-import {DeployStack} from "./DeployStack";
-import {Function, FunctionProps} from "aws-cdk-lib/aws-lambda";
-import {
-    JsonSchema,
-    LambdaIntegration,
-    MethodOptions,
-    Model,
-    RequestValidator,
-    IResource, Method
-} from "aws-cdk-lib/aws-apigateway";
-import {CfnOutput, Duration} from "aws-cdk-lib";
-import {applyHoneycombToLambda} from "./methods/apply-honeycomb-to-lambda";
-import {RetentionDays} from "aws-cdk-lib/aws-logs";
-import {RestApi} from "./RestApi";
-
-interface AddToApiOptions {
-    requestSchema?: JsonSchema,
-    methodOptions?: MethodOptions
-}
-
-export interface FunctionIntegrationProps {
-    funcProps: FunctionProps,
-    timeout?: Duration
-    memory?: number
-}
-
-export class FunctionIntegration extends Function {
-    stack: DeployStack
-    name: string
-
-    constructor(stack: DeployStack, id: string, options: FunctionIntegrationProps) {
-        const props = applyHoneycombToLambda(stack, {
-            functionName: stack.genName(id),
-            memorySize: options.memory || 256,
-            timeout: options.timeout || Duration.seconds(16),
-            logRetention: RetentionDays.ONE_WEEK,
-            ...options.funcProps
-        })
-
-        super(stack, stack.genId(id, 'lambda'), props);
-        this.stack = stack;
-        this.name = id;
-        stack.set('lambda', id, this)
-        new CfnOutput(stack, stack.genId(id, 'function-name'), {
-            value: this.functionName,
-            exportName: stack.genName(id, 'function-name')
-        });
-    }
-
-    attach(api: RestApi, httpMethod: string, path: string, props: AddToApiOptions = {}) : ApiAttachPoint {
-        const resource: IResource = api.path(path)
-        const integration = new LambdaIntegration(this, {
-            requestTemplates: {
-                'application/json': '{ "statusCode": "200" }'
-            }
-        })
-
-        let options: MethodOptions = props?.methodOptions || {}
-        const schema = props?.requestSchema
-        if (schema) options = applySchema(this.stack, this.name, schema, options, resource)
-
-        const method = resource.addMethod(httpMethod, integration, options)
-
-        return {
-            method,
-            resourceArn: `arn:aws:execute-api:${this.stack.region}:${this.stack.account}:${api.restApiId}/${this.stack.stage}/${httpMethod}${path}`
-        };
-    }
-}
-
-function applySchema(stack: DeployStack, name: string, schema: JsonSchema, options: MethodOptions, path: IResource): MethodOptions {
-    return {
-        ...options,
-        requestValidator: new RequestValidator(stack, stack.genId(name, 'validator'), {
-            restApi: path.api,
-            requestValidatorName: stack.genName(name, 'validator'),
-            validateRequestBody: true
-        }),
-        requestModels: {
-            'application/json': new Model(stack, stack.genId(name, 'model'), {
-                schema: schema,
-                contentType: 'application/json',
-                restApi: path.api,
-                modelName: stack.genId(name, 'model')
-            })
-        }
-    }
-}
-
-interface ApiAttachPoint {
-    method: Method
-    resourceArn: string
-}

package/src/ICorsConfig.ts

@@ -1,5 +0,0 @@
-export interface ICorsConfig {
-    maxAge?: number
-    exposeHeaders?: string[],
-    allowOrigin?: string|string[]
-}

package/src/IDomainConfig.ts

@@ -1,8 +0,0 @@
-import IHostedZoneConfig from "./IHostedZoneConfig";
-
-export interface IDomainConfig {
-    domainName: string,
-    subdomain?: string,
-    hostedZone: IHostedZoneConfig
-}
-export default IDomainConfig

package/src/IHostedZoneConfig.ts

@@ -1,5 +0,0 @@
-export interface IHostedZoneConfig {
-    name: string,
-    id: string
-}
-export default IHostedZoneConfig

package/src/IStackArguments.ts

@@ -1,8 +0,0 @@
-import {StackProps}  from 'aws-cdk-lib/core';
-
-export interface IStackArguments extends StackProps {
-    stage: string,
-    project: string,
-    owner: string
-}
-export default IStackArguments

package/src/NodeJsLambda.ts

@@ -1,31 +0,0 @@
-import {Code, FunctionOptions, Runtime} from "aws-cdk-lib/aws-lambda"
-import {DeployStack} from "./DeployStack";
-import {FunctionIntegration} from "./FunctionIntegration";
-import {buildNodeSource} from "./methods/build-node-source";
-import {Duration} from "aws-cdk-lib";
-import duration from "./methods/duration";
-
-interface NodeFunctionProps {
-    funcProps?: FunctionOptions
-    timeout?: Duration
-    memory?: number
-}
-
-export class NodeJsLambda extends FunctionIntegration {
-    constructor(stack: DeployStack, id: string, options?: NodeFunctionProps) {
-        console.log('Defining Node Lambda', id)
-        const done = duration()
-        const {buildDir} = buildNodeSource('lambda', id)
-        console.log('Total Build Duration (ms)', done())
-
-        super(stack, id, {
-            ...options,
-            funcProps: {
-                ...options?.funcProps,
-                code: Code.fromAsset(buildDir),
-                handler: `${id}.handler`,
-                runtime: Runtime.NODEJS_18_X
-            }
-        })
-    }
-}

package/src/NodeJsLambdaLayer.ts

@@ -1,27 +0,0 @@
-import {Code, LayerVersion, Runtime} from "aws-cdk-lib/aws-lambda";
-import {DeployStack} from "./DeployStack";
-import {LayerVersionOptions} from "aws-cdk-lib/aws-lambda/lib/layers";
-import {Architecture} from "aws-cdk-lib/aws-lambda/lib/architecture";
-import {buildNodeSource} from "./methods/build-node-source";
-import duration from "./methods/duration";
-
-interface NodeJsLambdaLayerProps extends LayerVersionOptions {
-    readonly compatibleRuntimes?: Runtime[];
-    readonly compatibleArchitectures?: Architecture[];
-}
-
-export class NodeJsLambdaLayer extends LayerVersion {
-    constructor(stack: DeployStack, id: string, props: NodeJsLambdaLayerProps = {}) {
-        console.log("Building Lambda Layer", id);
-        const done = duration()
-        const {buildDir} = buildNodeSource('lambda-layer', id, {dir:'nodejs'})
-        console.log('Build Duration (ms)', done())
-
-        super(stack, stack.genId(id), {
-            ...props,
-            layerVersionName: stack.genName(id),
-            code: Code.fromAsset(buildDir)
-        });
-        stack.set('lambda-layer', id, this)
-    }
-}

package/src/Output.ts

@@ -1,11 +0,0 @@
-import {CfnOutput} from 'aws-cdk-lib/core';
-import {DeployStack} from './DeployStack';
-
-export class Output extends CfnOutput {
-    constructor(stack: DeployStack, name: string, value: string) {
-        super(stack, stack.genId(name, 'output'), {
-            value,
-            exportName: stack.genName(name)
-        })
-    }
-}