@gradientedge/cdk-utils 8.81.0 → 8.82.0

package/dist/src/lib/construct/index.d.ts

@@ -6,4 +6,5 @@ export * from './graphql-api-lambda-with-cache';
 export * from './rest-api-lambda';
 export * from './rest-api-lambda-with-cache';
 export * from './site-with-ecs-backend';
+export * from './static-asset-deployment';
 export * from './static-site';

package/dist/src/lib/construct/index.js

@@ -22,4 +22,5 @@ __exportStar(require("./graphql-api-lambda-with-cache"), exports);
 __exportStar(require("./rest-api-lambda"), exports);
 __exportStar(require("./rest-api-lambda-with-cache"), exports);
 __exportStar(require("./site-with-ecs-backend"), exports);
+__exportStar(require("./static-asset-deployment"), exports);
 __exportStar(require("./static-site"), exports);

package/dist/src/lib/construct/static-asset-deployment/index.d.ts

@@ -0,0 +1,2 @@
+export * from './main';
+export * from './types';

package/dist/src/lib/construct/static-asset-deployment/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./main"), exports);
+__exportStar(require("./types"), exports);

package/dist/src/lib/construct/static-asset-deployment/main.d.ts

@@ -0,0 +1,45 @@
+import { CommonConstruct } from '../../common';
+import { Construct } from 'constructs';
+import * as s3 from 'aws-cdk-lib/aws-s3';
+import { StaticAssetDeploymentProps } from './types';
+/**
+ * @stability stable
+ * @category cdk-utils.static-asset-deployment
+ * @subcategory construct
+ * @classdesc Provides a construct to create and deploy static assets into S3 bucket
+ *
+ * @example
+ * import { StaticAssetDeployment, StaticAssetDeploymentProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends StaticAssetDeployment {
+ *   constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ * @mixin
+ */
+export declare class StaticAssetDeployment extends CommonConstruct {
+    props: StaticAssetDeploymentProps;
+    id: string;
+    staticAssetBucket: s3.IBucket;
+    constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps);
+    /**
+     * @summary Initialise and provision resources
+     * @protected
+     */
+    protected initResources(): void;
+    /**
+     * @summary Create the static asset bucket
+     * @protected
+     */
+    protected createAssetBucket(): void;
+    /**
+     * @summary Deploy the static assests into the static asset bucket
+     * @protected
+     */
+    protected deployStaticAssets(): void;
+}

package/dist/src/lib/construct/static-asset-deployment/main.js

@@ -0,0 +1,94 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticAssetDeployment = void 0;
+const common_1 = require("../../common");
+const s3deploy = __importStar(require("aws-cdk-lib/aws-s3-deployment"));
+/**
+ * @stability stable
+ * @category cdk-utils.static-asset-deployment
+ * @subcategory construct
+ * @classdesc Provides a construct to create and deploy static assets into S3 bucket
+ *
+ * @example
+ * import { StaticAssetDeployment, StaticAssetDeploymentProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends StaticAssetDeployment {
+ *   constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ * @mixin
+ */
+class StaticAssetDeployment extends common_1.CommonConstruct {
+    /* construct properties */
+    props;
+    id;
+    /* construct resources */
+    staticAssetBucket;
+    constructor(parent, id, props) {
+        super(parent, id, props);
+        this.props = props;
+        this.id = id;
+    }
+    /**
+     * @summary Initialise and provision resources
+     * @protected
+     */
+    initResources() {
+        this.createAssetBucket();
+        this.deployStaticAssets();
+    }
+    /**
+     * @summary Create the static asset bucket
+     * @protected
+     */
+    createAssetBucket() {
+        this.staticAssetBucket = this.s3Manager.createS3Bucket(`${this.id}-sa-bucket`, this, this.props.staticAssetBucket);
+    }
+    /**
+     * @summary Deploy the static assests into the static asset bucket
+     * @protected
+     */
+    deployStaticAssets() {
+        new s3deploy.BucketDeployment(this, `${this.id}-static-deployment`, {
+            ...this.props.staticAssetDeployment,
+            destinationBucket: this.staticAssetBucket,
+            sources: this.props.staticAssetSources,
+        });
+        const staticAssetsForExport = this.props.staticAssetsForExport;
+        if (!staticAssetsForExport)
+            return;
+        /* optional additional exports needed for asset urls */
+        staticAssetsForExport.forEach(asset => {
+            this.addCfnOutput(asset.key, this.staticAssetBucket.s3UrlForObject(asset.value));
+        });
+    }
+}
+exports.StaticAssetDeployment = StaticAssetDeployment;

package/dist/src/lib/construct/static-asset-deployment/types.d.ts

@@ -0,0 +1,11 @@
+import { BucketDeploymentProps, CommonStackProps, S3BucketProps } from '../../types';
+export interface AssetExport {
+    key: string;
+    value: string;
+}
+export interface StaticAssetDeploymentProps extends CommonStackProps {
+    staticAssetDeployment: BucketDeploymentProps;
+    staticAssetSources: any[];
+    staticAssetBucket: S3BucketProps;
+    staticAssetsForExport?: AssetExport[];
+}

package/dist/src/lib/construct/static-asset-deployment/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -717,7 +717,7 @@ export interface SfnStartExecutionProps extends tasks.StepFunctionsStartExecutio
     retries?: SfnRetryProps[];
 }
 /**
-   }
+ }
  * @category cdk-utils.event-manager
  * @subcategory Properties
  */
@@ -853,6 +853,14 @@ export interface LifecycleRule extends s3.LifecycleRule {
     expirationInDays?: number;
     noncurrentVersionExpirationInDays?: number;
 }
+/**
+ * @category cdk-utils.s3-manager
+ * @subcategory Properties
+ */
+export interface BucketDeploymentProps extends s3deploy.BucketDeploymentProps {
+    expirationInDays?: number;
+    noncurrentVersionExpirationInDays?: number;
+}
 /**
  * @category cdk-utils.dynamodb-manager
  * @subcategory Properties

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.81.0",
+  "version": "8.82.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -46,13 +46,13 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.348.0",
+    "@aws-sdk/client-secrets-manager": "^3.350.0",
     "@types/lodash": "^4.14.195",
-    "@types/node": "^20.2.5",
+    "@types/node": "^20.3.0",
     "@types/uuid": "^9.0.2",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.83.0",
-    "constructs": "^10.2.47",
+    "aws-cdk-lib": "^2.83.1",
+    "constructs": "^10.2.50",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "nconf": "^0.12.0",
@@ -65,9 +65,9 @@
     "@babel/eslint-parser": "^7.22.5",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@types/jest": "^29.5.2",
-    "@typescript-eslint/eslint-plugin": "^5.59.9",
-    "@typescript-eslint/parser": "^5.59.9",
-    "aws-cdk": "^2.83.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.11",
+    "@typescript-eslint/parser": "^5.59.11",
+    "aws-cdk": "^2.83.1",
     "better-docs": "^2.7.2",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.0",
@@ -89,7 +89,7 @@
     "prettier": "^2.8.8",
     "prettier-plugin-organize-imports": "^3.2.2",
     "rimraf": "^5.0.1",
-    "semantic-release": "^21.0.3",
+    "semantic-release": "^21.0.5",
     "taffydb": "^2.7.3",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",

package/src/lib/construct/index.ts

@@ -6,4 +6,5 @@ export * from './graphql-api-lambda-with-cache'
 export * from './rest-api-lambda'
 export * from './rest-api-lambda-with-cache'
 export * from './site-with-ecs-backend'
+export * from './static-asset-deployment'
 export * from './static-site'

package/src/lib/construct/static-asset-deployment/index.ts

@@ -0,0 +1,2 @@
+export * from './main'
+export * from './types'

package/src/lib/construct/static-asset-deployment/main.ts

@@ -0,0 +1,78 @@
+import { CommonConstruct } from '../../common'
+import { Construct } from 'constructs'
+import * as s3 from 'aws-cdk-lib/aws-s3'
+import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment'
+import { StaticAssetDeploymentProps } from './types'
+
+/**
+ * @stability stable
+ * @category cdk-utils.static-asset-deployment
+ * @subcategory construct
+ * @classdesc Provides a construct to create and deploy static assets into S3 bucket
+ *
+ * @example
+ * import { StaticAssetDeployment, StaticAssetDeploymentProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends StaticAssetDeployment {
+ *   constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ * @mixin
+ */
+export class StaticAssetDeployment extends CommonConstruct {
+  /* construct properties */
+  props: StaticAssetDeploymentProps
+  id: string
+
+  /* construct resources */
+  staticAssetBucket: s3.IBucket
+
+  constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps) {
+    super(parent, id, props)
+
+    this.props = props
+    this.id = id
+  }
+
+  /**
+   * @summary Initialise and provision resources
+   * @protected
+   */
+  protected initResources() {
+    this.createAssetBucket()
+    this.deployStaticAssets()
+  }
+
+  /**
+   * @summary Create the static asset bucket
+   * @protected
+   */
+  protected createAssetBucket() {
+    this.staticAssetBucket = this.s3Manager.createS3Bucket(`${this.id}-sa-bucket`, this, this.props.staticAssetBucket)
+  }
+
+  /**
+   * @summary Deploy the static assests into the static asset bucket
+   * @protected
+   */
+  protected deployStaticAssets() {
+    new s3deploy.BucketDeployment(this, `${this.id}-static-deployment`, {
+      ...this.props.staticAssetDeployment,
+      destinationBucket: this.staticAssetBucket,
+      sources: this.props.staticAssetSources,
+    })
+
+    const staticAssetsForExport = this.props.staticAssetsForExport
+    if (!staticAssetsForExport) return
+
+    /* optional additional exports needed for asset urls */
+    staticAssetsForExport.forEach(asset => {
+      this.addCfnOutput(asset.key, this.staticAssetBucket.s3UrlForObject(asset.value))
+    })
+  }
+}

package/src/lib/construct/static-asset-deployment/types.ts

@@ -0,0 +1,13 @@
+import { BucketDeploymentProps, CommonStackProps, S3BucketProps } from '../../types'
+
+export interface AssetExport {
+  key: string
+  value: string
+}
+
+export interface StaticAssetDeploymentProps extends CommonStackProps {
+  staticAssetDeployment: BucketDeploymentProps
+  staticAssetSources: any[]
+  staticAssetBucket: S3BucketProps
+  staticAssetsForExport?: AssetExport[]
+}

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

@@ -31,7 +31,6 @@ import * as types from '../index'
 import * as appAutoscaling from 'aws-cdk-lib/aws-applicationautoscaling'
 import * as pipes from 'aws-cdk-lib/aws-pipes'
 import * as evidently from 'aws-cdk-lib/aws-evidently'
-import { CfnExperimentProps, CfnFeatureProps, CfnSegmentProps } from 'aws-cdk-lib/aws-evidently/lib/evidently.generated'
 
 /**
  * @category cdk-utils.app-config-manager
@@ -767,7 +766,7 @@ export interface SfnStartExecutionProps extends tasks.StepFunctionsStartExecutio
 }
 
 /**
-   }
+ }
  * @category cdk-utils.event-manager
  * @subcategory Properties
  */
@@ -915,6 +914,15 @@ export interface LifecycleRule extends s3.LifecycleRule {
   noncurrentVersionExpirationInDays?: number
 }
 
+/**
+ * @category cdk-utils.s3-manager
+ * @subcategory Properties
+ */
+export interface BucketDeploymentProps extends s3deploy.BucketDeploymentProps {
+  expirationInDays?: number
+  noncurrentVersionExpirationInDays?: number
+}
+
 /**
  * @category cdk-utils.dynamodb-manager
  * @subcategory Properties