@gradientedge/cdk-utils 9.3.0 → 9.5.0

package/app/api-destined-function/node_modules/.bin/uuid

@@ -6,9 +6,9 @@ case `uname` in
 esac
 
 if [ -z "$NODE_PATH" ]; then
-  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/bin/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules"
+  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/dist/bin/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules"
 else
-  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/bin/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules:$NODE_PATH"
+  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/dist/bin/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules:$NODE_PATH"
 fi
 if [ -x "$basedir/node" ]; then
   exec "$basedir/node"  "$basedir/../uuid/dist/bin/uuid" "$@"

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

@@ -16,11 +16,11 @@
     "test": "npx jest --ci --runInBand --passWithNoTests"
   },
   "dependencies": {
-    "@types/uuid": "^9.0.8",
-    "uuid": "^9.0.1"
+    "@types/uuid": "^10.0.0",
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
     "mkdirp": "^3.0.1",
-    "rimraf": "^5.0.5"
+    "rimraf": "^5.0.7"
   }
 }

package/dist/src/lib/aws/utils/index.js

@@ -3,7 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.redirectSuccess = exports.redirectError = exports.determineCredentials = exports.createCfnOutput = void 0;
+exports.createCfnOutput = createCfnOutput;
+exports.determineCredentials = determineCredentials;
+exports.redirectError = redirectError;
+exports.redirectSuccess = redirectSuccess;
 const credential_providers_1 = require("@aws-sdk/credential-providers");
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const lodash_1 = __importDefault(require("lodash"));
@@ -28,7 +31,6 @@ function createCfnOutput(id, scope, value, description, overrideId = true) {
     }
     return output;
 }
-exports.createCfnOutput = createCfnOutput;
 /**
  *
  */
@@ -37,7 +39,6 @@ function determineCredentials() {
         return (0, credential_providers_1.fromIni)();
     return (0, credential_providers_1.fromEnv)();
 }
-exports.determineCredentials = determineCredentials;
 /**
  */
 const defaultResponseObject = {
@@ -58,7 +59,6 @@ function redirectError(error) {
         statusCode: 500,
     });
 }
-exports.redirectError = redirectError;
 /**
  * @param message
  */
@@ -68,4 +68,3 @@ function redirectSuccess(message) {
         statusCode: 200,
     });
 }
-exports.redirectSuccess = redirectSuccess;

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

@@ -1 +1,2 @@
 export * from './pages-static-site';
+export * from './worker-site';

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

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./pages-static-site"), exports);
+__exportStar(require("./worker-site"), exports);

package/dist/src/lib/cloudflare/construct/worker-site/index.d.ts

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

package/dist/src/lib/cloudflare/construct/worker-site/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/cloudflare/construct/worker-site/main.d.ts

@@ -0,0 +1,43 @@
+import { DataCloudflareZone } from '@cdktf/provider-cloudflare/lib/data-cloudflare-zone';
+import { WorkerScript, WorkerScriptPlainTextBinding, WorkerScriptSecretTextBinding } from '@cdktf/provider-cloudflare/lib/worker-script';
+import { Zone } from '@cdktf/provider-cloudflare/lib/zone';
+import { Construct } from 'constructs';
+import { CommonCloudflareConstruct } from '../../common';
+import { CloudflareWorkerSiteProps } from './types';
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare worker site
+ * @example
+ * import { CloudflareWorkerSite, CloudflareWorkerSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflareWorkerSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareWorkerSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+export declare class CloudflareWorkerSite extends CommonCloudflareConstruct {
+    props: CloudflareWorkerSiteProps;
+    siteZone: DataCloudflareZone | Zone;
+    siteWorkerScript: WorkerScript;
+    workerPlainTextBindingEnvironmentVariables: WorkerScriptPlainTextBinding[];
+    workerSecretTextBindingEnvironmentVariables: WorkerScriptSecretTextBinding[];
+    constructor(parent: Construct, id: string, props: CloudflareWorkerSiteProps);
+    /**
+     * @summary Initialise and provision resources
+     */
+    protected initResources(): void;
+    /**
+     * @summary Resolve the zone to use for the worker site
+     */
+    protected resolveZone(): void;
+    /**
+     * @summary Resolve the environment variables to use for the static site
+     */
+    protected resolveEnvironmentVariables(): void;
+    protected createWorker(): void;
+    protected createWorkerDomain(): void;
+}

package/dist/src/lib/cloudflare/construct/worker-site/main.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudflareWorkerSite = void 0;
+const cdktf_1 = require("cdktf");
+const common_1 = require("../../common");
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare worker site
+ * @example
+ * import { CloudflareWorkerSite, CloudflareWorkerSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflareWorkerSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareWorkerSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+class CloudflareWorkerSite extends common_1.CommonCloudflareConstruct {
+    /* worker site resources */
+    siteZone;
+    siteWorkerScript;
+    workerPlainTextBindingEnvironmentVariables;
+    workerSecretTextBindingEnvironmentVariables;
+    constructor(parent, id, props) {
+        super(parent, id, props);
+        this.props = props;
+        this.id = id;
+    }
+    /**
+     * @summary Initialise and provision resources
+     */
+    initResources() {
+        this.resolveZone();
+        this.resolveEnvironmentVariables();
+        this.createWorker();
+        this.createWorkerDomain();
+    }
+    /**
+     * @summary Resolve the zone to use for the worker site
+     */
+    resolveZone() {
+        if (this.props.useExistingZone) {
+            this.siteZone = this.zoneManager.resolveZone(`${this.id}-zone`, this);
+        }
+        else {
+            this.siteZone = this.zoneManager.createZone(`${this.id}-zone`, this, this.props.siteZone);
+        }
+    }
+    /**
+     * @summary Resolve the environment variables to use for the static site
+     */
+    resolveEnvironmentVariables() {
+        this.props.siteWorkerScript = {
+            ...this.props.siteWorkerScript,
+            plainTextBinding: this.workerPlainTextBindingEnvironmentVariables,
+            secretTextBinding: this.workerSecretTextBindingEnvironmentVariables,
+        };
+    }
+    createWorker() {
+        const workerContent = new cdktf_1.TerraformAsset(this, `${this.id}-worker-content`, {
+            path: this.props.siteWorkerAsset,
+            type: cdktf_1.AssetType.FILE,
+        });
+        this.siteWorkerScript = this.workerManager.createWorkerScript(`${this.id}-worker-script`, this, {
+            ...this.props.siteWorkerScript,
+            content: cdktf_1.Fn.file(workerContent.path),
+        });
+    }
+    createWorkerDomain() {
+        this.workerManager.createWorkerDomain(`${this.id}-worker-domain`, this, {
+            ...this.props.siteWorkerDomain,
+            hostname: `${this.props.siteSubDomain}.${this.props.domainName}`,
+            service: this.siteWorkerScript.name,
+        });
+    }
+}
+exports.CloudflareWorkerSite = CloudflareWorkerSite;

package/dist/src/lib/cloudflare/construct/worker-site/types.d.ts

@@ -0,0 +1,9 @@
+import { CommonCloudflareStackProps } from '../../common';
+import { WorkerDomainProps, WorkerScriptProps, ZoneProps } from '../../services';
+export interface CloudflareWorkerSiteProps extends CommonCloudflareStackProps {
+    siteSubDomain: string;
+    siteZone: ZoneProps;
+    siteWorkerScript: WorkerScriptProps;
+    siteWorkerDomain: WorkerDomainProps;
+    siteWorkerAsset: string;
+}

package/dist/src/lib/cloudflare/construct/worker-site/types.js

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

package/dist/src/lib/common/utils.d.ts

@@ -11,16 +11,16 @@ export declare enum LogLevel {
 /**
  * @param stage
  */
-export declare const isDevStage: (stage: string) => boolean;
+export declare const isDevStage: (stage: string) => stage is "dev";
 /**
  * @param stage
  */
-export declare const isTestStage: (stage: string) => boolean;
+export declare const isTestStage: (stage: string) => stage is "tst";
 /**
  * @param stage
  */
-export declare const isUatStage: (stage: string) => boolean;
+export declare const isUatStage: (stage: string) => stage is "uat";
 /**
  * @param stage
  */
-export declare const isPrdStage: (stage: string) => boolean;
+export declare const isPrdStage: (stage: string) => stage is "prd";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "9.3.0",
+  "version": "9.5.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -50,62 +50,62 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.554.0",
-    "@aws-sdk/credential-providers": "^3.554.0",
-    "@aws-sdk/types": "^3.535.0",
-    "@cdktf/provider-aws": "^19.14.0",
-    "@cdktf/provider-azurerm": "^12.12.0",
-    "@cdktf/provider-cloudflare": "^11.7.0",
-    "@types/lodash": "^4.17.0",
-    "@types/node": "^20.12.7",
-    "@types/uuid": "^9.0.8",
+    "@aws-sdk/client-secrets-manager": "^3.600.0",
+    "@aws-sdk/credential-providers": "^3.600.0",
+    "@aws-sdk/types": "^3.598.0",
+    "@cdktf/provider-aws": "^19.23.0",
+    "@cdktf/provider-azurerm": "^12.21.0",
+    "@cdktf/provider-cloudflare": "^11.13.0",
+    "@types/lodash": "^4.17.5",
+    "@types/node": "^20.14.8",
+    "@types/uuid": "^10.0.0",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.141.0",
+    "aws-cdk-lib": "^2.147.1",
     "cdktf": "^0.20.7",
-    "cdktf-local-exec": "^0.5.13",
+    "cdktf-local-exec": "^0.5.23",
     "constructs": "^10.3.0",
     "lodash": "^4.17.21",
     "moment": "^2.30.1",
     "nconf": "^0.12.1",
     "pluralize": "^8.0.0",
     "ts-node": "^10.9.2",
-    "uuid": "^9.0.1"
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.4",
-    "@babel/eslint-parser": "^7.24.1",
+    "@babel/core": "^7.24.7",
+    "@babel/eslint-parser": "^7.24.7",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
-    "aws-cdk": "^2.137.0",
+    "@typescript-eslint/eslint-plugin": "^7.14.1",
+    "@typescript-eslint/parser": "^7.14.1",
+    "aws-cdk": "^2.147.1",
     "better-docs": "^2.7.3",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.0",
     "docdash": "^2.0.2",
     "dotenv": "^16.4.5",
-    "eslint": "^9.0.0",
+    "eslint": "^9.5.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.2.3",
+    "eslint-plugin-jsdoc": "^48.4.0",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
     "jest-junit": "^16.0.0",
-    "jsdoc": "^4.0.2",
+    "jsdoc": "^4.0.3",
     "jsdoc-babel": "^0.5.0",
     "jsdoc-mermaid": "^1.0.0",
     "jsdoc-plugin-typescript": "^2.2.1",
     "jsdoc-to-markdown": "^8.0.1",
-    "prettier": "^3.2.5",
+    "prettier": "^3.3.2",
     "prettier-plugin-organize-imports": "^3.2.4",
-    "rimraf": "^5.0.5",
-    "semantic-release": "^23.0.8",
+    "rimraf": "^5.0.7",
+    "semantic-release": "^24.0.0",
     "taffydb": "^2.7.3",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",
-    "typescript": "5.4.5",
-    "yaml": "^2.4.2"
+    "typescript": "5.5.2",
+    "yaml": "^2.4.5"
   },
   "optionalDependencies": {
     "prop-types": "^15.8.1",

package/src/lib/cloudflare/construct/index.ts

@@ -1 +1,2 @@
 export * from './pages-static-site'
+export * from './worker-site'

package/src/lib/cloudflare/construct/worker-site/index.ts

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

package/src/lib/cloudflare/construct/worker-site/main.ts

@@ -0,0 +1,94 @@
+import { DataCloudflareZone } from '@cdktf/provider-cloudflare/lib/data-cloudflare-zone'
+import {
+  WorkerScript,
+  WorkerScriptPlainTextBinding,
+  WorkerScriptSecretTextBinding,
+} from '@cdktf/provider-cloudflare/lib/worker-script'
+import { Zone } from '@cdktf/provider-cloudflare/lib/zone'
+import { Fn, TerraformAsset, AssetType } from 'cdktf'
+import { Construct } from 'constructs'
+import { CommonCloudflareConstruct } from '../../common'
+import { CloudflareWorkerSiteProps } from './types'
+
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare worker site
+ * @example
+ * import { CloudflareWorkerSite, CloudflareWorkerSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflareWorkerSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareWorkerSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+export class CloudflareWorkerSite extends CommonCloudflareConstruct {
+  declare props: CloudflareWorkerSiteProps
+
+  /* worker site resources */
+  siteZone: DataCloudflareZone | Zone
+  siteWorkerScript: WorkerScript
+  workerPlainTextBindingEnvironmentVariables: WorkerScriptPlainTextBinding[]
+  workerSecretTextBindingEnvironmentVariables: WorkerScriptSecretTextBinding[]
+
+  constructor(parent: Construct, id: string, props: CloudflareWorkerSiteProps) {
+    super(parent, id, props)
+    this.props = props
+    this.id = id
+  }
+
+  /**
+   * @summary Initialise and provision resources
+   */
+  protected initResources() {
+    this.resolveZone()
+    this.resolveEnvironmentVariables()
+    this.createWorker()
+    this.createWorkerDomain()
+  }
+
+  /**
+   * @summary Resolve the zone to use for the worker site
+   */
+  protected resolveZone() {
+    if (this.props.useExistingZone) {
+      this.siteZone = this.zoneManager.resolveZone(`${this.id}-zone`, this)
+    } else {
+      this.siteZone = this.zoneManager.createZone(`${this.id}-zone`, this, this.props.siteZone)
+    }
+  }
+
+  /**
+   * @summary Resolve the environment variables to use for the static site
+   */
+  protected resolveEnvironmentVariables() {
+    this.props.siteWorkerScript = {
+      ...this.props.siteWorkerScript,
+      plainTextBinding: this.workerPlainTextBindingEnvironmentVariables,
+      secretTextBinding: this.workerSecretTextBindingEnvironmentVariables,
+    }
+  }
+
+  protected createWorker() {
+    const workerContent = new TerraformAsset(this, `${this.id}-worker-content`, {
+      path: this.props.siteWorkerAsset,
+      type: AssetType.FILE,
+    })
+
+    this.siteWorkerScript = this.workerManager.createWorkerScript(`${this.id}-worker-script`, this, {
+      ...this.props.siteWorkerScript,
+      content: Fn.file(workerContent.path),
+    })
+  }
+
+  protected createWorkerDomain() {
+    this.workerManager.createWorkerDomain(`${this.id}-worker-domain`, this, {
+      ...this.props.siteWorkerDomain,
+      hostname: `${this.props.siteSubDomain}.${this.props.domainName}`,
+      service: this.siteWorkerScript.name,
+    })
+  }
+}

package/src/lib/cloudflare/construct/worker-site/types.ts

@@ -0,0 +1,10 @@
+import { CommonCloudflareStackProps } from '../../common'
+import { WorkerDomainProps, WorkerScriptProps, RecordProps, ZoneProps } from '../../services'
+
+export interface CloudflareWorkerSiteProps extends CommonCloudflareStackProps {
+  siteSubDomain: string
+  siteZone: ZoneProps
+  siteWorkerScript: WorkerScriptProps
+  siteWorkerDomain: WorkerDomainProps
+  siteWorkerAsset: string
+}