@gradientedge/cdk-utils 8.144.0 → 8.146.0

package/dist/src/lib/cloudflare/common/constants.d.ts

@@ -0,0 +1,4 @@
+export declare enum RemoteBackend {
+    local = "local",
+    s3 = "s3"
+}

package/dist/src/lib/cloudflare/common/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteBackend = void 0;
+var RemoteBackend;
+(function (RemoteBackend) {
+    RemoteBackend["local"] = "local";
+    RemoteBackend["s3"] = "s3";
+})(RemoteBackend || (exports.RemoteBackend = RemoteBackend = {}));

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

@@ -20,6 +20,15 @@ export declare class CommonCloudflareConstruct extends TerraformStack {
      * @summary Determine the fully qualified domain name based on domainName & subDomain
      */
     protected determineFullyQualifiedDomain(): void;
+    /**
+     * @summary Determine the account id based on the cdktf.json context
+     */
+    protected determineAccountId(): void;
+    /**
+     * @summary Determine the api token based on the cdktf.json context
+     */
+    protected determineApiToken(): void;
+    protected determineRemoteBackend(): void;
     /**
      * @summary Utility method to determine if the initialisation is in development (dev) stage
      * This is determined by the stage property injected via cdk context

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

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonCloudflareConstruct = void 0;
-const provider_1 = require("@cdktf/provider-cloudflare/lib/provider");
+const provider_1 = require("@cdktf/provider-aws/lib/provider");
+const provider_2 = require("@cdktf/provider-cloudflare/lib/provider");
 const cdktf_1 = require("cdktf");
 const common_1 = require("../../common");
 const services_1 = require("../services");
+const constants_1 = require("./constants");
+const data_aws_s3_bucket_object_1 = require("@cdktf/provider-aws/lib/data-aws-s3-bucket-object");
 class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
     id;
     fullyQualifiedDomainName;
@@ -31,7 +34,10 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
         this.workerManager = new services_1.CloudflareWorkerManager();
         this.zoneManager = new services_1.CloudflareZoneManager();
         this.determineFullyQualifiedDomain();
-        new provider_1.CloudflareProvider(this, `${this.id}-provider`, this.props);
+        this.determineAccountId();
+        this.determineApiToken();
+        this.determineRemoteBackend();
+        new provider_2.CloudflareProvider(this, `${this.id}-provider`, this.props);
     }
     /**
      * @summary Determine the fully qualified domain name based on domainName & subDomain
@@ -41,6 +47,49 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
             ? `${this.props.subDomain}.${this.props.domainName}`
             : this.props.domainName;
     }
+    /**
+     * @summary Determine the account id based on the cdktf.json context
+     */
+    determineAccountId() {
+        this.props.accountId = new cdktf_1.TerraformVariable(this, `accountId`, {}).stringValue;
+    }
+    /**
+     * @summary Determine the api token based on the cdktf.json context
+     */
+    determineApiToken() {
+        this.props.apiToken = new cdktf_1.TerraformVariable(this, `apiToken`, {}).stringValue;
+    }
+    determineRemoteBackend() {
+        const debug = this.node.tryGetContext('debug');
+        switch (this.props.remoteBackend?.type) {
+            case constants_1.RemoteBackend.s3:
+                new provider_1.AwsProvider(this, `${this.id}-aws-provider`, {
+                    profile: process.env.AWS_PROFILE ?? 'default',
+                    region: this.props.remoteBackend.region,
+                });
+                new cdktf_1.S3Backend(this, {
+                    bucket: this.props.remoteBackend.bucketName,
+                    dynamodbTable: this.props.remoteBackend.tableName,
+                    key: `${this.id}`,
+                    profile: process.env.AWS_PROFILE ?? 'default',
+                    region: this.props.remoteBackend.region,
+                });
+                new data_aws_s3_bucket_object_1.DataAwsS3BucketObject(this, `${this.id}-remote-state-ref`, {
+                    bucket: this.props.remoteBackend.bucketName,
+                    key: new cdktf_1.DataTerraformRemoteStateS3(this, `${this.id}-remote-state`, {
+                        bucket: this.props.remoteBackend.bucketName,
+                        key: `${this.id}`,
+                    }).getString('bucket_key'),
+                });
+                break;
+            case constants_1.RemoteBackend.local:
+                if (debug)
+                    console.debug(`Using local backend for ${this.id}`);
+                break;
+            default:
+                break;
+        }
+    }
     /**
      * @summary Utility method to determine if the initialisation is in development (dev) stage
      * This is determined by the stage property injected via cdk context

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

@@ -1,3 +1,4 @@
+export * from './constants';
 export * from './construct';
 export * from './stack';
 export * from './types';

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

@@ -14,6 +14,7 @@ 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("./constants"), exports);
 __exportStar(require("./construct"), exports);
 __exportStar(require("./stack"), exports);
 __exportStar(require("./types"), exports);

package/dist/src/lib/cloudflare/common/stack.d.ts

@@ -25,6 +25,7 @@ export declare class CommonCloudflareStack extends TerraformStack {
      */
     protected determineConstructProps(props: CommonCloudflareStackProps): {
         accountId: any;
+        apiToken: any;
         domainName: any;
         extraContexts: any;
         features: any;

package/dist/src/lib/cloudflare/common/stack.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonCloudflareStack = void 0;
 const fs_1 = __importDefault(require("fs"));
-const construct_1 = require("./construct");
 const app_root_path_1 = __importDefault(require("app-root-path"));
 const cdktf_1 = require("cdktf");
 const lodash_1 = __importDefault(require("lodash"));
@@ -32,8 +31,6 @@ class CommonCloudflareStack extends cdktf_1.TerraformStack {
         /* determine extra cdk stage contexts */
         this.determineStageContexts();
         this.props = this.determineConstructProps(props);
-        /* initialise the construct */
-        this.construct = new construct_1.CommonCloudflareConstruct(this, 'cdk-utils', this.props);
     }
     /**
      * @summary Method to determine the core CDK construct properties injected via context cdktf.json
@@ -41,14 +38,16 @@ class CommonCloudflareStack extends cdktf_1.TerraformStack {
      * @returns The stack properties
      */
     determineConstructProps(props) {
+        const stage = this.node.tryGetContext('stage');
         return {
             accountId: this.node.tryGetContext('accountId'),
+            apiToken: this.node.tryGetContext('apiToken'),
             domainName: this.node.tryGetContext('domainName'),
             extraContexts: this.node.tryGetContext('extraContexts'),
             features: this.node.tryGetContext('features'),
             name: this.node.tryGetContext('resourceGroupName'),
             skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
-            stage: this.node.tryGetContext('stage'),
+            stage: stage,
             subDomain: this.node.tryGetContext('subDomain'),
         };
     }

package/dist/src/lib/cloudflare/common/types.d.ts

@@ -1,7 +1,17 @@
 import { CloudflareProviderConfig } from '@cdktf/provider-cloudflare/lib/provider';
 import { BaseProps } from '../../common';
+import { RemoteBackend } from './constants';
+export interface RemoteBackendProps {
+    bucketName: string;
+    region: string;
+    tableName: string;
+    type: RemoteBackend;
+}
 /**
  */
 export interface CommonCloudflareStackProps extends BaseProps, CloudflareProviderConfig {
     accountId: string;
+    apiToken: string;
+    remoteBackend?: RemoteBackendProps;
+    useExistingZone?: boolean;
 }

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

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

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

@@ -0,0 +1,17 @@
+"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("./pages-static-site"), exports);

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

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

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

@@ -0,0 +1,55 @@
+import { DataCloudflareZone } from '@cdktf/provider-cloudflare/lib/data-cloudflare-zone';
+import { PagesDomain } from '@cdktf/provider-cloudflare/lib/pages-domain';
+import { PagesProject } from '@cdktf/provider-cloudflare/lib/pages-project';
+import { Record } from '@cdktf/provider-cloudflare/lib/record';
+import { Zone } from '@cdktf/provider-cloudflare/lib/zone';
+import { Construct } from 'constructs';
+import { CommonCloudflareConstruct } from '../../common';
+import { CloudflarePagesStaticSiteProps } from './types';
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare pages static site
+ * @example
+ * import { CloudflarePagesStaticSite, CloudflareStaticSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflarePagesStaticSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareStaticSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+export declare class CloudflarePagesStaticSite extends CommonCloudflareConstruct {
+    props: CloudflarePagesStaticSiteProps;
+    sitePagesCnameRecord: Record;
+    sitePagesDomain: PagesDomain;
+    sitePagesProject: PagesProject;
+    siteZone: DataCloudflareZone | Zone;
+    constructor(parent: Construct, id: string, props: CloudflarePagesStaticSiteProps);
+    /**
+     * @summary Initialise and provision resources
+     */
+    protected initResources(): void;
+    /**
+     * @summary Resolve the zone to use for the static site
+     */
+    protected resolveZone(): void;
+    /**
+     * @summary Create the pages project
+     */
+    protected createProject(): void;
+    /**
+     * @summary Create the pages domain
+     */
+    protected createDomain(): void;
+    /**
+     * @summary Create the pages cname record
+     */
+    protected createRecord(): void;
+    /**
+     * @summary Deploy the pages project
+     */
+    protected deploySite(): void;
+}

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

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudflarePagesStaticSite = void 0;
+const common_1 = require("../../common");
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare pages static site
+ * @example
+ * import { CloudflarePagesStaticSite, CloudflareStaticSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflarePagesStaticSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareStaticSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+class CloudflarePagesStaticSite extends common_1.CommonCloudflareConstruct {
+    /* static site resources */
+    sitePagesCnameRecord;
+    sitePagesDomain;
+    sitePagesProject;
+    siteZone;
+    constructor(parent, id, props) {
+        super(parent, id, props);
+        this.props = props;
+        this.id = id;
+    }
+    /**
+     * @summary Initialise and provision resources
+     */
+    initResources() {
+        this.resolveZone();
+        this.createProject();
+        this.createDomain();
+        this.createRecord();
+        this.deploySite();
+    }
+    /**
+     * @summary Resolve the zone to use for the static 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 Create the pages project
+     */
+    createProject() {
+        this.sitePagesProject = this.pageManager.createPagesProject(`${this.id}-site-project`, this, this.props.sitePagesProject);
+    }
+    /**
+     * @summary Create the pages domain
+     */
+    createDomain() {
+        this.sitePagesDomain = this.pageManager.createPagesDomain(`${this.id}-site-domain`, this, {
+            accountId: this.props.accountId,
+            domain: `${this.props.siteSubDomain}.${this.props.domainName}`,
+            projectName: this.sitePagesProject.name,
+        });
+    }
+    /**
+     * @summary Create the pages cname record
+     */
+    createRecord() {
+        this.sitePagesCnameRecord = this.recordManager.createRecord(`${this.id}-site-record`, this, {
+            ...this.props.siteCnameRecord,
+            name: this.props.siteSubDomain,
+            value: `${this.sitePagesProject.name}.pages.dev`,
+        });
+    }
+    /**
+     * @summary Deploy the pages project
+     */
+    deploySite() {
+        this.pageManager.deployPagesProject(`${this.id}-deploy`, this, {
+            branch: this.props.siteBranch ?? 'main',
+            directory: this.props.siteAssetDir,
+            message: this.props.siteDeployMessage,
+            projectName: this.sitePagesProject.name,
+        });
+    }
+}
+exports.CloudflarePagesStaticSite = CloudflarePagesStaticSite;

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

@@ -0,0 +1,11 @@
+import { CommonCloudflareStackProps } from '../../common';
+import { PagesProjectProps, RecordProps, ZoneProps } from '../../services';
+export interface CloudflarePagesStaticSiteProps extends CommonCloudflareStackProps {
+    siteAssetDir: string;
+    siteBranch?: string;
+    siteCnameRecord: RecordProps;
+    siteDeployMessage: string;
+    sitePagesProject: PagesProjectProps;
+    siteSubDomain: string;
+    siteZone: ZoneProps;
+}

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

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

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

@@ -1,4 +1,5 @@
 export * from './common';
+export * from './construct';
 export * from './services';
 export * from './types';
 export * from './utils';

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

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./common"), exports);
+__exportStar(require("./construct"), exports);
 __exportStar(require("./services"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);

package/dist/src/lib/cloudflare/services/page/main.d.ts

@@ -1,8 +1,9 @@
+import { PageRule } from '@cdktf/provider-cloudflare/lib/page-rule';
 import { PagesDomain } from '@cdktf/provider-cloudflare/lib/pages-domain';
 import { PagesProject } from '@cdktf/provider-cloudflare/lib/pages-project';
+import { LocalExec } from 'cdktf-local-exec';
 import { CommonCloudflareConstruct } from '../../common';
-import { PageRuleProps, PagesDomainProps, PagesProjectProps } from './types';
-import { PageRule } from '@cdktf/provider-cloudflare/lib/page-rule';
+import { PageRuleProps, PagesDomainProps, PagesProjectDeployProps, PagesProjectProps } from './types';
 /**
  * @classdesc Provides operations on Cloudflare Pages
  * - A new instance of this class is injected into {@link CommonCloudflareConstruct} constructor.
@@ -45,4 +46,5 @@ export declare class CloudflarePageManager {
      * @see [CDKTF Page Rule Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/pageRule.typescript.md}
      */
     createPageRule(id: string, scope: CommonCloudflareConstruct, props: PageRuleProps): PageRule;
+    deployPagesProject(id: string, scope: CommonCloudflareConstruct, props: PagesProjectDeployProps): LocalExec;
 }

package/dist/src/lib/cloudflare/services/page/main.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CloudflarePageManager = void 0;
+const page_rule_1 = require("@cdktf/provider-cloudflare/lib/page-rule");
 const pages_domain_1 = require("@cdktf/provider-cloudflare/lib/pages-domain");
 const pages_project_1 = require("@cdktf/provider-cloudflare/lib/pages-project");
+const cdktf_local_exec_1 = require("cdktf-local-exec");
 const utils_1 = require("../../utils");
-const page_rule_1 = require("@cdktf/provider-cloudflare/lib/page-rule");
 /**
  * @classdesc Provides operations on Cloudflare Pages
  * - A new instance of this class is injected into {@link CommonCloudflareConstruct} constructor.
@@ -82,5 +83,17 @@ class CloudflarePageManager {
         (0, utils_1.createCloudflareTfOutput)(`${id}-pageRuleId`, scope, pageRule.id);
         return pageRule;
     }
+    deployPagesProject(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const localExecProvider = new cdktf_local_exec_1.Provider(scope, `${id}`);
+        const branch = scope.isProductionStage() ? 'main' : props.branch;
+        const message = process.env.BUILD_NUMBER ?? props.message;
+        const deployment = new cdktf_local_exec_1.LocalExec(scope, `${id}-deploy-${new Date().toISOString()}`, {
+            command: `CLOUDFLARE_ACCOUNT_ID=${scope.props.accountId} CLOUDFLARE_API_TOKEN=${scope.props.apiToken} npx wrangler pages deploy ${props.directory} --project-name=${props.projectName} --branch=${props.branch} --commit-message=${message}`,
+            cwd: '',
+        });
+        return deployment;
+    }
 }
 exports.CloudflarePageManager = CloudflarePageManager;

package/dist/src/lib/cloudflare/services/page/types.d.ts

@@ -7,3 +7,9 @@ export interface PagesDomainProps extends PagesDomainConfig {
 }
 export interface PageRuleProps extends PageRuleConfig {
 }
+export interface PagesProjectDeployProps {
+    branch: string;
+    directory: string;
+    message: string;
+    projectName: string;
+}

package/dist/src/lib/cloudflare/services/zone/main.d.ts

@@ -34,7 +34,7 @@ export declare class CloudflareZoneManager {
      * @see [CDKTF Zone Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zone.typescript.md}
      */
     createZone(id: string, scope: CommonCloudflareConstruct, props: ZoneProps): Zone;
-    resolveZone(id: string, scope: CommonCloudflareConstruct, options: ZoneOptions): DataCloudflareZone;
+    resolveZone(id: string, scope: CommonCloudflareConstruct, options?: ZoneOptions): DataCloudflareZone;
     /**
      * @summary Method to create a new zone cache reserve
      * @param id scoped id of the resource

package/dist/src/lib/cloudflare/services/zone/main.js

@@ -49,12 +49,10 @@ class CloudflareZoneManager {
         return zone;
     }
     resolveZone(id, scope, options) {
-        if (!options)
-            throw `Options undefined for ${id}`;
         const zone = new data_cloudflare_zone_1.DataCloudflareZone(scope, `${id}-data-zone`, {
             accountId: scope.props.accountId,
-            name: options.name ?? scope.props.domainName,
-            zoneId: options.id,
+            name: options?.name ?? scope.props.domainName,
+            zoneId: options?.id,
         });
         return zone;
     }

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

@@ -2,7 +2,7 @@ export interface BaseProps {
     domainName: string;
     extraContexts?: string[];
     name: string;
-    skipStageForARecords: boolean;
+    skipStageForARecords?: boolean;
     stage: string;
     stageContextPath?: string;
     subDomain?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.144.0",
+  "version": "8.146.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -47,17 +47,19 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.454.0",
-    "@aws-sdk/credential-providers": "^3.454.0",
+    "@aws-sdk/client-secrets-manager": "^3.458.0",
+    "@aws-sdk/credential-providers": "^3.458.0",
     "@aws-sdk/types": "^3.451.0",
-    "@cdktf/provider-azurerm": "^11.0.5",
+    "@cdktf/provider-aws": "^18.0.6",
+    "@cdktf/provider-azurerm": "^11.0.6",
     "@cdktf/provider-cloudflare": "^10.0.3",
-    "@types/lodash": "^4.14.201",
-    "@types/node": "^20.9.2",
+    "@types/lodash": "^4.14.202",
+    "@types/node": "^20.10.0",
     "@types/uuid": "^9.0.7",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.110.0",
+    "aws-cdk-lib": "^2.110.1",
     "cdktf": "^0.19.1",
+    "cdktf-local-exec": "^0.4.8",
     "constructs": "^10.3.0",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
@@ -70,10 +72,10 @@
     "@babel/core": "^7.23.3",
     "@babel/eslint-parser": "^7.23.3",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@types/jest": "^29.5.8",
-    "@typescript-eslint/eslint-plugin": "^6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
-    "aws-cdk": "^2.110.0",
+    "@types/jest": "^29.5.10",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
+    "aws-cdk": "^2.110.1",
     "better-docs": "^2.7.2",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.0",
@@ -99,7 +101,7 @@
     "taffydb": "^2.7.3",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "5.2.2"
+    "typescript": "5.3.2"
   },
   "optionalDependencies": {
     "prop-types": "^15.8.1",

package/src/lib/cloudflare/common/constants.ts

@@ -0,0 +1,4 @@
+export enum RemoteBackend {
+  local = 'local',
+  s3 = 's3',
+}

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

@@ -1,5 +1,6 @@
+import { AwsProvider } from '@cdktf/provider-aws/lib/provider'
 import { CloudflareProvider } from '@cdktf/provider-cloudflare/lib/provider'
-import { TerraformStack } from 'cdktf'
+import { DataTerraformRemoteStateS3, S3Backend, TerraformStack, TerraformVariable } from 'cdktf'
 import { Construct } from 'constructs'
 import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
 import {
@@ -13,7 +14,9 @@ import {
   CloudflareWorkerManager,
   CloudflareZoneManager,
 } from '../services'
+import { RemoteBackend } from './constants'
 import { CommonCloudflareStackProps } from './types'
+import { DataAwsS3BucketObject } from '@cdktf/provider-aws/lib/data-aws-s3-bucket-object'
 
 export class CommonCloudflareConstruct extends TerraformStack {
   declare props: CommonCloudflareStackProps
@@ -45,18 +48,67 @@ export class CommonCloudflareConstruct extends TerraformStack {
     this.zoneManager = new CloudflareZoneManager()
 
     this.determineFullyQualifiedDomain()
+    this.determineAccountId()
+    this.determineApiToken()
+    this.determineRemoteBackend()
     new CloudflareProvider(this, `${this.id}-provider`, this.props)
   }
 
   /**
    * @summary Determine the fully qualified domain name based on domainName & subDomain
    */
-  protected determineFullyQualifiedDomain(): void {
+  protected determineFullyQualifiedDomain() {
     this.fullyQualifiedDomainName = this.props.subDomain
       ? `${this.props.subDomain}.${this.props.domainName}`
       : this.props.domainName
   }
 
+  /**
+   * @summary Determine the account id based on the cdktf.json context
+   */
+  protected determineAccountId() {
+    this.props.accountId = new TerraformVariable(this, `accountId`, {}).stringValue
+  }
+
+  /**
+   * @summary Determine the api token based on the cdktf.json context
+   */
+  protected determineApiToken() {
+    this.props.apiToken = new TerraformVariable(this, `apiToken`, {}).stringValue
+  }
+
+  protected determineRemoteBackend() {
+    const debug = this.node.tryGetContext('debug')
+    switch (this.props.remoteBackend?.type) {
+      case RemoteBackend.s3:
+        new AwsProvider(this, `${this.id}-aws-provider`, {
+          profile: process.env.AWS_PROFILE ?? 'default',
+          region: this.props.remoteBackend.region,
+        })
+        new S3Backend(this, {
+          bucket: this.props.remoteBackend.bucketName,
+          dynamodbTable: this.props.remoteBackend.tableName,
+          key: `${this.id}`,
+          profile: process.env.AWS_PROFILE ?? 'default',
+          region: this.props.remoteBackend.region,
+        })
+        new DataAwsS3BucketObject(this, `${this.id}-remote-state-ref`, {
+          bucket: this.props.remoteBackend.bucketName,
+          key: new DataTerraformRemoteStateS3(this, `${this.id}-remote-state`, {
+            bucket: this.props.remoteBackend.bucketName,
+            key: `${this.id}`,
+          }).getString('bucket_key'),
+        })
+
+        break
+      case RemoteBackend.local:
+        if (debug) console.debug(`Using local backend for ${this.id}`)
+        break
+      default:
+        break
+    }
+  }
+
   /**
    * @summary Utility method to determine if the initialisation is in development (dev) stage
    * This is determined by the stage property injected via cdk context

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

@@ -1,3 +1,4 @@
+export * from './constants'
 export * from './construct'
 export * from './stack'
 export * from './types'

package/src/lib/cloudflare/common/stack.ts

@@ -7,6 +7,7 @@ import { TerraformStack } from 'cdktf'
 import { Construct } from 'constructs'
 import _ from 'lodash'
 import { isDevStage } from '../../common'
+import { RemoteBackend } from './constants'
 
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
@@ -34,9 +35,6 @@ export class CommonCloudflareStack extends TerraformStack {
     this.determineStageContexts()
 
     this.props = this.determineConstructProps(props)
-
-    /* initialise the construct */
-    this.construct = new CommonCloudflareConstruct(this, 'cdk-utils', this.props)
   }
 
   /**
@@ -45,14 +43,16 @@ export class CommonCloudflareStack extends TerraformStack {
    * @returns The stack properties
    */
   protected determineConstructProps(props: CommonCloudflareStackProps) {
+    const stage = this.node.tryGetContext('stage')
     return {
       accountId: this.node.tryGetContext('accountId'),
+      apiToken: this.node.tryGetContext('apiToken'),
       domainName: this.node.tryGetContext('domainName'),
       extraContexts: this.node.tryGetContext('extraContexts'),
       features: this.node.tryGetContext('features'),
       name: this.node.tryGetContext('resourceGroupName'),
       skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
-      stage: this.node.tryGetContext('stage'),
+      stage: stage,
       subDomain: this.node.tryGetContext('subDomain'),
     }
   }

package/src/lib/cloudflare/common/types.ts

@@ -1,8 +1,19 @@
 import { CloudflareProviderConfig } from '@cdktf/provider-cloudflare/lib/provider'
 import { BaseProps } from '../../common'
+import { RemoteBackend } from './constants'
+
+export interface RemoteBackendProps {
+  bucketName: string
+  region: string
+  tableName: string
+  type: RemoteBackend
+}
 
 /**
  */
 export interface CommonCloudflareStackProps extends BaseProps, CloudflareProviderConfig {
   accountId: string
+  apiToken: string
+  remoteBackend?: RemoteBackendProps
+  useExistingZone?: boolean
 }

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

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

package/src/lib/cloudflare/construct/pages-static-site/index.ts

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

package/src/lib/cloudflare/construct/pages-static-site/main.ts

@@ -0,0 +1,106 @@
+import { DataCloudflareZone } from '@cdktf/provider-cloudflare/lib/data-cloudflare-zone'
+import { PagesDomain } from '@cdktf/provider-cloudflare/lib/pages-domain'
+import { PagesProject } from '@cdktf/provider-cloudflare/lib/pages-project'
+import { Record } from '@cdktf/provider-cloudflare/lib/record'
+import { Zone } from '@cdktf/provider-cloudflare/lib/zone'
+import { Construct } from 'constructs'
+import { CommonCloudflareConstruct } from '../../common'
+import { CloudflarePagesStaticSiteProps } from './types'
+
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare pages static site
+ * @example
+ * import { CloudflarePagesStaticSite, CloudflareStaticSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflarePagesStaticSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareStaticSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+export class CloudflarePagesStaticSite extends CommonCloudflareConstruct {
+  declare props: CloudflarePagesStaticSiteProps
+
+  /* static site resources */
+  sitePagesCnameRecord: Record
+  sitePagesDomain: PagesDomain
+  sitePagesProject: PagesProject
+  siteZone: DataCloudflareZone | Zone
+
+  constructor(parent: Construct, id: string, props: CloudflarePagesStaticSiteProps) {
+    super(parent, id, props)
+    this.props = props
+    this.id = id
+  }
+
+  /**
+   * @summary Initialise and provision resources
+   */
+  protected initResources() {
+    this.resolveZone()
+    this.createProject()
+    this.createDomain()
+    this.createRecord()
+    this.deploySite()
+  }
+
+  /**
+   * @summary Resolve the zone to use for the static 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 Create the pages project
+   */
+  protected createProject() {
+    this.sitePagesProject = this.pageManager.createPagesProject(
+      `${this.id}-site-project`,
+      this,
+      this.props.sitePagesProject
+    )
+  }
+
+  /**
+   * @summary Create the pages domain
+   */
+  protected createDomain() {
+    this.sitePagesDomain = this.pageManager.createPagesDomain(`${this.id}-site-domain`, this, {
+      accountId: this.props.accountId,
+      domain: `${this.props.siteSubDomain}.${this.props.domainName}`,
+      projectName: this.sitePagesProject.name,
+    })
+  }
+
+  /**
+   * @summary Create the pages cname record
+   */
+  protected createRecord() {
+    this.sitePagesCnameRecord = this.recordManager.createRecord(`${this.id}-site-record`, this, {
+      ...this.props.siteCnameRecord,
+      name: this.props.siteSubDomain,
+      value: `${this.sitePagesProject.name}.pages.dev`,
+    })
+  }
+
+  /**
+   * @summary Deploy the pages project
+   */
+  protected deploySite() {
+    this.pageManager.deployPagesProject(`${this.id}-deploy`, this, {
+      branch: this.props.siteBranch ?? 'main',
+      directory: this.props.siteAssetDir,
+      message: this.props.siteDeployMessage,
+      projectName: this.sitePagesProject.name,
+    })
+  }
+}

package/src/lib/cloudflare/construct/pages-static-site/types.ts

@@ -0,0 +1,12 @@
+import { CommonCloudflareStackProps } from '../../common'
+import { PagesProjectProps, RecordProps, ZoneProps } from '../../services'
+
+export interface CloudflarePagesStaticSiteProps extends CommonCloudflareStackProps {
+  siteAssetDir: string
+  siteBranch?: string
+  siteCnameRecord: RecordProps
+  siteDeployMessage: string
+  sitePagesProject: PagesProjectProps
+  siteSubDomain: string
+  siteZone: ZoneProps
+}

package/src/lib/cloudflare/index.ts

@@ -1,4 +1,5 @@
 export * from './common'
+export * from './construct'
 export * from './services'
 export * from './types'
 export * from './utils'

package/src/lib/cloudflare/services/page/main.ts

@@ -1,9 +1,10 @@
+import { PageRule } from '@cdktf/provider-cloudflare/lib/page-rule'
 import { PagesDomain } from '@cdktf/provider-cloudflare/lib/pages-domain'
 import { PagesProject } from '@cdktf/provider-cloudflare/lib/pages-project'
+import { LocalExec, Provider } from 'cdktf-local-exec'
 import { CommonCloudflareConstruct } from '../../common'
 import { createCloudflareTfOutput } from '../../utils'
-import { PageRuleProps, PagesDomainProps, PagesProjectProps } from './types'
-import { PageRule } from '@cdktf/provider-cloudflare/lib/page-rule'
+import { PageRuleProps, PagesDomainProps, PagesProjectDeployProps, PagesProjectProps } from './types'
 
 /**
  * @classdesc Provides operations on Cloudflare Pages
@@ -91,4 +92,18 @@ export class CloudflarePageManager {
 
     return pageRule
   }
+
+  public deployPagesProject(id: string, scope: CommonCloudflareConstruct, props: PagesProjectDeployProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const localExecProvider = new Provider(scope, `${id}`)
+    const branch = scope.isProductionStage() ? 'main' : props.branch
+    const message = process.env.BUILD_NUMBER ?? props.message
+    const deployment = new LocalExec(scope, `${id}-deploy-${new Date().toISOString()}`, {
+      command: `CLOUDFLARE_ACCOUNT_ID=${scope.props.accountId} CLOUDFLARE_API_TOKEN=${scope.props.apiToken} npx wrangler pages deploy ${props.directory} --project-name=${props.projectName} --branch=${props.branch} --commit-message=${message}`,
+      cwd: '',
+    })
+
+    return deployment
+  }
 }

package/src/lib/cloudflare/services/page/types.ts

@@ -5,3 +5,9 @@ import { PagesProjectConfig } from '@cdktf/provider-cloudflare/lib/pages-project
 export interface PagesProjectProps extends PagesProjectConfig {}
 export interface PagesDomainProps extends PagesDomainConfig {}
 export interface PageRuleProps extends PageRuleConfig {}
+export interface PagesProjectDeployProps {
+  branch: string
+  directory: string
+  message: string
+  projectName: string
+}

package/src/lib/cloudflare/services/zone/main.ts

@@ -60,13 +60,11 @@ export class CloudflareZoneManager {
     return zone
   }
 
-  public resolveZone(id: string, scope: CommonCloudflareConstruct, options: ZoneOptions) {
-    if (!options) throw `Options undefined for ${id}`
-
+  public resolveZone(id: string, scope: CommonCloudflareConstruct, options?: ZoneOptions) {
     const zone = new DataCloudflareZone(scope, `${id}-data-zone`, {
       accountId: scope.props.accountId,
-      name: options.name ?? scope.props.domainName,
-      zoneId: options.id,
+      name: options?.name ?? scope.props.domainName,
+      zoneId: options?.id,
     })
 
     return zone

package/src/lib/common/types.ts

@@ -2,7 +2,7 @@ export interface BaseProps {
   domainName: string
   extraContexts?: string[]
   name: string
-  skipStageForARecords: boolean
+  skipStageForARecords?: boolean
   stage: string
   stageContextPath?: string
   subDomain?: string